Skip to main content
PATCH
/
v1
/
organizations
Update Organization
curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organization_name": "<string>",
  "billing_email": "jsmith@example.com",
  "metadata": {},
  "rate_limits": {
    "metadata": 20,
    "data": 10,
    "search": 10,
    "upload": 5,
    "compute": 5
  }
}'
{
  "account_type": "pro",
  "created_at": "2025-01-01T00:00:00Z",
  "credit_count": 250000,
  "internal_id": "int_x1y2z3",
  "organization_id": "org_demo123",
  "organization_name": "Acme Corporation"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

Body

application/json

Partial update payload for organization metadata.

​
organization_name
string | null

Updated display name for the organization.

​
billing_email
string<email> | null

Updated billing contact email.

​
metadata
object | null

Replace metadata with provided dictionary when set.

​
rate_limits
object | null

Override the computed rate limits for the organization. Rate limits by operation type (requests per minute).

The rate limiting system uses 5 categories aligned with actual resource consumption:

Categories: metadata: Infrastructure and configuration operations (namespaces, collections, retrievers, taxonomies, clusters CRUD). Zero-credit operations with highest rate limits.

data: Data operations (objects, documents CRUD). Low-credit operations with
      high rate limits.

search: Search and retrieval operations (retriever/taxonomy execution).
        Medium-credit operations with moderate rate limits.

upload: File upload operations (credit-intensive: 1 credit/MB). Variable-credit
        operations with lower rate limits.

compute: Compute operations (cluster execution, batch processing). High-credit
         operations (10 credits/min video) with lowest rate limits.

Rate Limit Strategy: Higher limits for low-cost operations (metadata, data) Lower limits for high-cost operations (upload, compute) This aligns API throttling with actual infrastructure costs

Examples: - Creating a namespace: Uses 'metadata' category (fast, cheap) - Uploading a file: Uses 'upload' category (slow, expensive per MB) - Executing a retriever: Uses 'search' category (moderate cost) - Running batch processing: Uses 'compute' category (very expensive)

Response

Successful Response

Response model for organization endpoints.

​
internal_id
string
required
​
organization_id
string
required
​
organization_name
string
required
​
account_type
enum<string>
required

Account tier with monthly credit allocations.

Tiers: FREE: 1,000 credits/month - Limited modalities, shared compute PRO: 100,000 credits/month - All modalities, dedicated namespace TEAM: 1,000,000 credits/month - Shared buckets, retrieval DAGs ENTERPRISE: Custom credits - Dedicated Ray cluster, SLA

Available options:
free,
pro,
team,
enterprise
​
credit_count
integer
required
​
rate_limits
object
required

Rate limits by operation type (requests per minute).

The rate limiting system uses 5 categories aligned with actual resource consumption:

Categories: metadata: Infrastructure and configuration operations (namespaces, collections, retrievers, taxonomies, clusters CRUD). Zero-credit operations with highest rate limits.

data: Data operations (objects, documents CRUD). Low-credit operations with
      high rate limits.

search: Search and retrieval operations (retriever/taxonomy execution).
        Medium-credit operations with moderate rate limits.

upload: File upload operations (credit-intensive: 1 credit/MB). Variable-credit
        operations with lower rate limits.

compute: Compute operations (cluster execution, batch processing). High-credit
         operations (10 credits/min video) with lowest rate limits.

Rate Limit Strategy: Higher limits for low-cost operations (metadata, data) Lower limits for high-cost operations (upload, compute) This aligns API throttling with actual infrastructure costs

Examples: - Creating a namespace: Uses 'metadata' category (fast, cheap) - Uploading a file: Uses 'upload' category (slow, expensive per MB) - Executing a retriever: Uses 'search' category (moderate cost) - Running batch processing: Uses 'compute' category (very expensive)

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
metadata
object
​
billing_email
string<email> | null
​
users
Users · object[] | null