Skip to main content
DocumentationIdentity and access · console.eu.ccsio.ai

Limits

The request limits of an organization (tenant limits).

Documentation menu

The descriptions of the operations and fields are the contract’s own, in English.

GET/identity/v1/organizations/{org}/limits

List every configured limits row of an organization

Credential
API key
Permission
Any oforganization.updateentitlements.managesupport-access.read

Needs organization.update in the organization (the Root and Organization Admin roles hold it), or entitlements.manage at platform level (a platform operator, for the organization they select, member or not).

Read more

The limits are the configured numbers: the Inference Router receives them in the signed context of each inference request. Returns the organization's baseline row (if configured) and every team, model, deployment and API key override: the rows the Router's limits are rendered from. A row of scope api_key also carries the name, the public prefix and the state of its API key (api_key_name, api_key_prefix, api_key_state: nothing of the key's owner, creator or principal), so the reader does not have to list the organization's keys, which needs an open support session for a platform operator; the three are null when the key no longer exists in the organization. Failures: 400 name-invalid; 404 organization-not-found (an unknown organization, never an empty list); 500 server faults.

curl
curl "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/limits" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

Responses

  • 200

    Every configured limits row of the organization.

    Schema
    ListTenantLimitsResponse
    • limitsarray of TenantLimitsrequired
      • organization_idstringrequired

        pattern ^[a-z][a-z0-9._-]{0,63}$

      • scopestringrequired

        Allowed values: "organization""team""model""deployment""api_key"

      • team_idstring or nullrequired

        pattern ^[a-z][a-z0-9._-]{0,63}$

      • model_refstring or nullrequired

        pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

      • deployment_idstring or nullrequired

        pattern ^[a-z][a-z0-9._-]{0,63}$

      • api_key_idstring or nullrequired

        pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

      • api_key_namestring or nullrequired

        The name of the API key the row limits, as the API key operations show it. Null unless the scope is api_key, and null when the organization has no such key (it never existed or was deleted).

        1 to 128 characters

      • api_key_prefixstring or nullrequired

        The display prefix of the API key the row limits (ccsio_ plus the first 8 entropy characters), the same prefix the API key operations show; never the raw value, never a digest. Null unless the scope is api_key, and null when the organization has no such key.

        pattern ^ccsio_[A-Za-z0-9_-]{8}$

      • api_key_statestring or nullrequired

        The state of the API key the row limits: active, or revoked (a revoked key that has not been deleted). Null unless the scope is api_key, and null when the organization has no such key.

        Allowed values: "active""revoked"

      • max_concurrent_requestsinteger or nullrequired

        How many requests may run at once; null means unlimited.

        0 to 2147483647

      • requests_per_minuteinteger or nullrequired

        How many requests may start per minute; null means unlimited.

        0 to 2147483647

      • input_tokens_per_minuteinteger or nullrequired

        How many input (prompt) tokens may be used per minute; null means unlimited. Always null unless the scope is organization or api_key.

        0 to 2147483647

      • output_tokens_per_minuteinteger or nullrequired

        How many output (generated) tokens may be used per minute; null means unlimited. Always null unless the scope is organization or api_key.

        0 to 2147483647

      • created_atstring (date-time)required

        RFC 3339, second precision, UTC.

      • updated_atstring (date-time)required

        RFC 3339, second precision, UTC.

  • 400

    Client refusal unrelated to authentication, including malformed input, a denied or failed request.

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `organization.update` or `support-access.read` in the organization, nor `entitlements.manage` at platform level (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch). Codes: policy-denied, tenant-mismatch

  • 404

    The requested resource or path was not found.

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    An operator's read under an open support session could not be recorded, so nothing was served. Codes: support-audit-unavailable

PUT/identity/v1/organizations/{org}/limits

Write one limits row of an organization

Credential
API key
Permission
Any oforganization.updateentitlements.manage
Request body
Body up to 1 MiB

Needs organization.update in the organization (the Root and Organization Admin roles hold it), or entitlements.manage at platform level (a platform operator, for the organization they select, member or not).

Read more

The limits are the configured numbers: the Inference Router receives them in the signed context of each inference request. The organization-wide row (scope organization) is the platform's ceiling for the organization: only a platform operator (entitlements.manage at platform level) writes or removes it; anyone else gets 403 tenant-limits-operator-only. The team, model, deployment and API key rows stay with the organization's administrators: the organization-wide row applies to every request as well, so they can only narrow it. Writes one row: the organization-wide baseline (scope organization) or an override for a team, a model, a deployment or an API key (scope api_key). scope is required, and exactly the one key it names is required with a scope other than organization (team, model_ref, deployment_id or api_key_id) and none with scope organization. The keys are stored as given: none is checked against the organization's teams, models, deployments or API keys. api_key_id is the id of an API key (the key_id of the API-key operations, never the key itself): the Inference Router applies the row to the requests made with that key, beside the organization's own limits, so a request must be within both and an API key row can only narrow. max_concurrent_requests, requests_per_minute, input_tokens_per_minute and output_tokens_per_minute are each independently optional: absent or null means unlimited, never a magic number; present, each must be a whole number from 0 up to 2147483647 (0 is a deliberate limit that blocks everything; a negative value is 400 tenant-limits-invalid, and a larger one is a server fault). The two token limits (the tokens of the prompt, and the tokens generated, per minute) are accepted only with scope organization and scope api_key; with any other scope a value that is not null is 400 tenant-limits-invalid and the message names the field. A write fully replaces the row's limit values, never merges them, and repeating a request writes the same row. The stored row is returned as the list returns it, an api_key row with its key's api_key_name, api_key_prefix and api_key_state (null when the organization has no such key). Failures: 400 invalid-request (scope missing, or an unknown member or a value that is not a whole number); 400 tenant-limits-invalid (a scope outside the five, a scope and key that do not go together, a key outside its pattern, a negative value, a token limit with a scope that takes none); 400 name-invalid (the path organization outside the C7 pattern); 404 organization-not-found; 500 server faults.

curl
curl -X PUT "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/limits" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "scope": "organization"
}'
Built from the schema’s required members: replace the values.

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

Request body application/json

PutTenantLimitsRequest
  • scopestringrequired

    Allowed values: "organization""team""model""deployment""api_key"

  • teamstringoptional

    Required with scope team, and not allowed with any other scope.

    pattern ^[a-z][a-z0-9._-]{0,63}$

  • model_refstringoptional

    Required with scope model, and not allowed with any other scope.

    pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

  • deployment_idstringoptional

    Required with scope deployment, and not allowed with any other scope.

    pattern ^[a-z][a-z0-9._-]{0,63}$

  • api_key_idstringoptional

    Required with scope api_key, and not allowed with any other scope. The id of the API key (never the key itself); it is stored as given.

    pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

  • max_concurrent_requestsinteger or nulloptional

    How many requests may run at once. A non-negative whole number up to 2147483647 (a larger one is a server fault, 500); absent or null means unlimited, never a magic number, and 0 is a deliberate limit that blocks everything.

    0 to 2147483647

  • requests_per_minuteinteger or nulloptional

    How many requests may start per minute. A non-negative whole number up to 2147483647 (a larger one is a server fault, 500); absent or null means unlimited, never a magic number, and 0 is a deliberate limit that blocks everything.

    0 to 2147483647

  • input_tokens_per_minuteinteger or nulloptional

    How many input (prompt) tokens may be used per minute. Accepted only with scope organization and scope api_key (any other scope with a value that is not null is 400 tenant-limits-invalid). A non-negative whole number up to 2147483647 (a larger one is a server fault, 500); absent or null means unlimited, never a magic number, and 0 is a deliberate limit that blocks everything.

    0 to 2147483647

  • output_tokens_per_minuteinteger or nulloptional

    How many output (generated) tokens may be used per minute. Accepted only with scope organization and scope api_key (any other scope with a value that is not null is 400 tenant-limits-invalid). A non-negative whole number up to 2147483647 (a larger one is a server fault, 500); absent or null means unlimited, never a magic number, and 0 is a deliberate limit that blocks everything.

    0 to 2147483647

Responses

  • 200

    The stored limits row.

    Schema
    TenantLimits
    • organization_idstringrequired

      pattern ^[a-z][a-z0-9._-]{0,63}$

    • scopestringrequired

      Allowed values: "organization""team""model""deployment""api_key"

    • team_idstring or nullrequired

      pattern ^[a-z][a-z0-9._-]{0,63}$

    • model_refstring or nullrequired

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • deployment_idstring or nullrequired

      pattern ^[a-z][a-z0-9._-]{0,63}$

    • api_key_idstring or nullrequired

      pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$

    • api_key_namestring or nullrequired

      The name of the API key the row limits, as the API key operations show it. Null unless the scope is api_key, and null when the organization has no such key (it never existed or was deleted).

      1 to 128 characters

    • api_key_prefixstring or nullrequired

      The display prefix of the API key the row limits (ccsio_ plus the first 8 entropy characters), the same prefix the API key operations show; never the raw value, never a digest. Null unless the scope is api_key, and null when the organization has no such key.

      pattern ^ccsio_[A-Za-z0-9_-]{8}$

    • api_key_statestring or nullrequired

      The state of the API key the row limits: active, or revoked (a revoked key that has not been deleted). Null unless the scope is api_key, and null when the organization has no such key.

      Allowed values: "active""revoked"

    • max_concurrent_requestsinteger or nullrequired

      How many requests may run at once; null means unlimited.

      0 to 2147483647

    • requests_per_minuteinteger or nullrequired

      How many requests may start per minute; null means unlimited.

      0 to 2147483647

    • input_tokens_per_minuteinteger or nullrequired

      How many input (prompt) tokens may be used per minute; null means unlimited. Always null unless the scope is organization or api_key.

      0 to 2147483647

    • output_tokens_per_minuteinteger or nullrequired

      How many output (generated) tokens may be used per minute; null means unlimited. Always null unless the scope is organization or api_key.

      0 to 2147483647

    • created_atstring (date-time)required

      RFC 3339, second precision, UTC.

    • updated_atstring (date-time)required

      RFC 3339, second precision, UTC.

  • 400

    Client refusal unrelated to authentication, including malformed input, a denied or failed request.

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `organization.update` in the organization nor `entitlements.manage` at platform level (policy-denied), the organization the request names is not the caller's own (tenant-mismatch), or the row is the organization-wide one and the caller is not a platform operator (tenant-limits-operator-only). Codes: policy-denied, tenant-mismatch, tenant-limits-operator-only

  • 404

    The requested resource or path was not found.

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 500

    Platform failure, rendered without internal cause details.

DELETE/identity/v1/organizations/{org}/limits

Remove one limits row of an organization

Credential
API key
Permission
Any oforganization.updateentitlements.manage

Needs organization.update in the organization (the Root and Organization Admin roles hold it), or entitlements.manage at platform level (a platform operator, for the organization they select, member or not).

Read more

The limits are the configured numbers: the Inference Router receives them in the signed context of each inference request. The organization-wide row (scope organization) is the platform's ceiling for the organization: only a platform operator (entitlements.manage at platform level) writes or removes it; anyone else gets 403 tenant-limits-operator-only. The team, model, deployment and API key rows stay with the organization's administrators: the organization-wide row applies to every request as well, so they can only narrow it. scope is a required query parameter (400 invalid-request when it is missing). The key of the row goes with a scope other than organization: team, model_ref, deployment_id or api_key_id, query-carried because a C0 ref may contain '/' and ':', which path segments mangle. Send only the key the scope names: with scope organization every key is ignored, and when several keys are sent api_key_id wins over deployment_id, which wins over model_ref, which wins over team. The row is physically deleted and reverts to unconfigured, which is unlimited. A scope or key that matches no row (a missing key included) finds none: 404 tenant-limits-not-found. Failures: 400 invalid-request (scope missing); 400 name-invalid (the path organization outside the C7 pattern); 404 tenant-limits-not-found; 500 server faults.

curl
curl -X DELETE "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/limits?scope=<scope>" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

scope
required
querystring

The scope of the row: organization, team, model, deployment or api_key.

team
optional
querystring

The team of the row, with scope team.

model_ref
optional
querystring

The model of the row, with scope model.

deployment_id
optional
querystring

The deployment of the row, with scope deployment.

api_key_id
optional
querystring

The id of the API key of the row, with scope api_key.

Responses

  • 200

    The removal acknowledgment.

    Schema
    StatusRemoved
    • statusstringrequired

      always "removed"

  • 400

    Client refusal unrelated to authentication, including malformed input, a denied or failed request.

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `organization.update` in the organization nor `entitlements.manage` at platform level (policy-denied), the organization the request names is not the caller's own (tenant-mismatch), or the row is the organization-wide one and the caller is not a platform operator (tenant-limits-operator-only). Codes: policy-denied, tenant-mismatch, tenant-limits-operator-only

  • 404

    The requested resource or path was not found.

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 500

    Platform failure, rendered without internal cause details.

GET/identity/v1/organizations/{org}/limits/api-keys

List the API keys of an organization by id and name, to set their limits

Credential
API key
Permission
Any oforganization.updateentitlements.manage

Needs organization.update in the organization (the Root and Organization Admin roles hold it), or entitlements.manage at platform level (a platform operator, for the organization they select with X-Organization-Id, which names the same organization as the path, member or not): the permission of the limits routes.

Read more

It exists so that an operator can name an organization's API keys when setting a per-key limit (PUT .../limits with scope api_key) without a support session: the API key list names the owners and needs one for an operator, and this answer never does. Returns every API key of the organization that is not deleted, a revoked one included (state revoked) because a limits row may still name it, sorted by name (in byte order) and then by key id. Each entry is the key id, the name, the public prefix, the state, the creation time and the expiry (null when the key has none) and nothing else: never the owner, an email, the principal, the creator, the hash or the raw value. An organization without keys answers {"api_keys": []}. It is a read like any other of the organization's own and is not recorded as a support access. Failures: 400 name-invalid; 404 organization-not-found (an unknown organization, never an empty list); 500 server faults.

curl
curl "https://console.eu.ccsio.ai/identity/v1/organizations/{org}/limits/api-keys" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameters

NameInDescription
X-Request-ID
optional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

org
required
pathstring

The organization id (C7 identifier). A value outside the pattern is refused with 400 name-invalid.

Responses

  • 200

    Every API key of the organization that is not deleted, by name and key id.

    Schema
    ListLimitAPIKeysResponse
    • api_keysarray of LimitAPIKeyrequired
      • key_idstringrequired

        The platform-minted key id (uppercase ULID).

        pattern ^[0-9A-HJKMNP-TV-Z]{26}$

      • namestringrequired

        1 to 128 characters

      • prefixstringrequired

        The display prefix (ccsio_ plus the first 8 entropy characters) — never the raw value, never a digest.

        pattern ^ccsio_[A-Za-z0-9_-]{8}$

      • statestringrequired

        The key state; revoked is terminal.

        Allowed values: "active""revoked"

      • created_atstring (date-time)required

        RFC 3339, second precision, UTC.

      • expires_atstring (date-time) or nullrequired

        RFC 3339, second precision, UTC; null when the key has no expiry.

  • 400

    Client refusal unrelated to authentication, including malformed input, a denied or failed request.

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Read more

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 402

    The organization has to pay first: its standing is payment_required.

    Read more

    The request boundary applies this payment gate to every route except an organization's billing routes, the caller's own context, organization list, onboarding, session report and personal keys, the public routes, and the routes of platform operators, who administer an organization that has to pay. The operations the gate covers declare this response. On /v1 the refusal is rendered in the OpenAI error format. Code: payment-required

  • 403

    No role of the caller holds `organization.update` in the organization, nor `entitlements.manage` at platform level (policy-denied), or the organization the request names is not the caller's own (tenant-mismatch). Codes: policy-denied, tenant-mismatch

  • 404

    The requested resource or path was not found.

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 500

    Platform failure, rendered without internal cause details.

Generated from the platform contracts at commit 5954fbc1.

Explore the platform

Get your first API key

Registration is open. Four steps to your first call: create your account, create your organization, create your API key, and start using it.

  1. 01Create your account
  2. 02Create your organization
  3. 03Create your API key
  4. 04Start using it