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>",
  "logo_url": "<string>",
  "billing_email": "jsmith@example.com",
  "notifications_email": "jsmith@example.com",
  "metadata": {},
  "rate_limit_overrides": {
    "metadata": 10,
    "data": 10,
    "search": 10,
    "upload": 10,
    "compute": 10
  },
  "default_llm_credentials": {},
  "nsfw_check_enabled": true,
  "nsfw_fail_closed": true
}
'
{
  "organization_id": "<string>",
  "organization_name": "<string>",
  "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",
  "logo_url": "<string>",
  "metadata": {},
  "billing_email": "jsmith@example.com",
  "notifications_email": "jsmith@example.com",
  "auto_billing_enabled": false,
  "billing_cycle_start": 1,
  "current_month_usage": 0,
  "users": [
    {}
  ],
  "auth_provider_org_id": "<string>",
  "default_llm_credentials": {},
  "api_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Partial update payload for organization metadata.

​
organization_name
string | null

Updated display name for the organization.

​
logo_url
string | null

Updated organization logo URL (e.g., custom logo to override auto-generated logo).

​
billing_email
string<email> | null

Updated billing contact email.

​
notifications_email
string<email> | null

Set the opt-in single address that receives alert/system notifications (None leaves it unchanged via exclude_unset).

​
metadata
Metadata · object | null

Replace metadata with provided dictionary when set.

​
rate_limit_overrides
BaseRateLimits · object | null

Per-org rate-limit overrides (merged on top of tier defaults).

​
default_llm_credentials
Default Llm Credentials · object | null

Map of provider names to secret names for org-wide LLM credentials.

​
nsfw_check_enabled
boolean | null

Toggle NSFW upload classification + hard-reject for this organization. Applies only to SHARED-plane tenants (infrastructure is None). None leaves the current setting unchanged.

​
nsfw_fail_closed
boolean | null

Toggle fail-closed behaviour for the NSFW gate (reject uploads when the classifier is unavailable instead of allowing them). None leaves the current setting unchanged.

Response

Successful Response

Response model for organization endpoints.

SECURITY: Does NOT expose internal_id to prevent leakage of high-entropy secrets. Only organization_id (public identifier) is included in API responses.

​
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)

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
logo_url
string | null
​
metadata
Metadata · object
​
billing_email
string<email> | null
​
notifications_email
string<email> | null
​
auto_billing_enabled
boolean
default:false
​
billing_cycle_start
integer
default:1
​
current_month_usage
integer
default:0
​
users
Users · object[] | null
​
auth_provider_org_id
string | null
​
default_llm_credentials
Default Llm Credentials · object
​
api_url
string | null