Update Organization

curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_name": "<string>",
  "billing_email": "[email protected]",
  "metadata": {},
  "rate_limits": {
    "metadata": 10,
    "data": 10,
    "search": 10,
    "upload": 10,
    "compute": 10
  }
}
'

{
  "internal_id": "<string>",
  "organization_id": "<string>",
  "organization_name": "<string>",
  "account_type": "free",
  "credit_count": 123,
  "rate_limits": {
    "metadata": 10,
    "data": 10,
    "search": 10,
    "upload": 10,
    "compute": 10
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "billing_email": "[email protected]",
  "users": [
    {}
  ]
}

PATCH

organizations

Update Organization

curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_name": "<string>",
  "billing_email": "[email protected]",
  "metadata": {},
  "rate_limits": {
    "metadata": 10,
    "data": 10,
    "search": 10,
    "upload": 10,
    "compute": 10
  }
}
'

{
  "internal_id": "<string>",
  "organization_id": "<string>",
  "organization_name": "<string>",
  "account_type": "free",
  "credit_count": 123,
  "rate_limits": {
    "metadata": 10,
    "data": 10,
    "search": 10,
    "upload": 10,
    "compute": 10
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "billing_email": "[email protected]",
  "users": [
    {}
  ]
}

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.

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

Metadata · object

Replace metadata with provided dictionary when set.

rate_limits

BaseRateLimits · object

Override the computed rate limits for the organization.

Show child attributes

rate_limits.metadata

integer

default:10

REQUIRED. Rate limit for infrastructure and configuration operations (namespaces, collections, retrievers, taxonomies, clusters CRUD). These are zero-credit operations with highest rate limits since they're cheap to execute. Examples: creating collections, updating retrievers, listing namespaces.

Required range: x >= 1

rate_limits.data

integer

default:10

REQUIRED. Rate limit for data operations (objects, documents CRUD). Low-credit operations with high rate limits. Examples: creating documents, updating objects, batch document updates.

Required range: x >= 1

rate_limits.search

integer

default:10

REQUIRED. Rate limit for search and retrieval operations (retriever/taxonomy execution). Medium-credit operations with moderate rate limits. Examples: executing retrievers, running taxonomy matching.

Required range: x >= 1

rate_limits.upload

integer

default:10

REQUIRED. Rate limit for file upload operations. Credit-intensive (1 credit/MB) with lower rate limits to prevent excessive resource consumption. Examples: uploading files, generating presigned URLs.

Required range: x >= 1

rate_limits.compute

integer

default:10

REQUIRED. Rate limit for compute operations (cluster execution, batch processing). High-credit operations (10 credits/min video) with lowest rate limits. Examples: submitting batches, executing clusters, triggering syncs.

Required range: x >= 1

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

BaseRateLimits · 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)

Show child attributes

rate_limits.metadata

integer

default:10

Required range: x >= 1

rate_limits.data

integer

default:10

REQUIRED. Rate limit for data operations (objects, documents CRUD). Low-credit operations with high rate limits. Examples: creating documents, updating objects, batch document updates.

Required range: x >= 1

rate_limits.search

integer

default:10

REQUIRED. Rate limit for search and retrieval operations (retriever/taxonomy execution). Medium-credit operations with moderate rate limits. Examples: executing retrievers, running taxonomy matching.

Required range: x >= 1

rate_limits.upload

integer

default:10

REQUIRED. Rate limit for file upload operations. Credit-intensive (1 credit/MB) with lower rate limits to prevent excessive resource consumption. Examples: uploading files, generating presigned URLs.

Required range: x >= 1

rate_limits.compute

integer

default:10

Required range: x >= 1

created_at

string<date-time>

required

updated_at

string<date-time>

required

metadata

Metadata · object

billing_email

string<email> | null

users

Users · object[] | null

Get Organization Add Credits

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

Update Organization

Headers

Body

Response