Usage

Read a usage fact back by idempotency key

Anmeldedaten

API-Key

Berechtigung

usage.read

curl "https://console.eu.ccsio.ai/metering/v1/usage?idempotency_key=<idempotency_key>" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

Antworten

• 200

  The usage fact, in its C2 wire form.

  Schema

  UsageRecord

  • deployment_idstring or nulloptional

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

  • provider_classanyoptional

    Erlaubte Werte: "CCSIO_INFERENCE""CUSTOMER_HOSTED""EXTERNAL_MANAGED"null

  • request_duration_msinteger or nulloptional

    Whole router request timing, shared by all attempt records; absent on legacy records.

    0 to 9007199254740991

  • request_ttft_msinteger or nulloptional

    Whole router request timing, shared by all attempt records; absent on legacy records.

    0 to 9007199254740991

  • session_idstring or nulloptional

    Client-provided session label (the X-Session-Id request header), copied onto every attempt record of the request; absent or null when the client sent none. It groups requests for the operator; it is never an identity and never used for authorization or tenancy.

    pattern ^[A-Za-z0-9._:-]{1,128}$

  • http_statusinteger or nulloptional

    The HTTP status the router answered for the whole request: its single response, identical on every attempt record of the request (the per-attempt result is outcome_class). A request that failed after the response header was committed (a stream cut mid-way) keeps the committed status, 200. Absent or null on legacy records.

    100 to 599

  • error_codestring or nulloptional

    The stable error code of the router's response to the request (the OpenAI-format error.code, or the platform error code on the routes that answer in that envelope), identical on every attempt record of the request; for a stream cut after the header was committed it is the code of the terminal error frame, or, on the surfaces that write no terminal frame (a cut chat stream, an aborted audio transfer), the code the failure classifies to. Null or absent when the request succeeded and on legacy records.

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

  • api_key_idstring or nulloptional

    The id of the API key the request was authenticated with (the key's key_id in the identity API, never the key itself), copied by the router from the signed context onto every attempt record of the request; absent or null for a request made without an API key, such as one from a console session. It says which credential was used; it is never an identity and never used for authorization or tenancy.

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

  • schema_versionanyPflicht

    always "c2/v1"

  • event_idstringPflicht

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

  • idempotency_keyobjectPflicht

    • tenant_idstringPflicht

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

    • plane_instance_idstringPflicht

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

    • request_or_run_idstringPflicht

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

    • attemptintegerPflicht

      1 to 9007199254740991

    • provider_response_idone of or nullPflicht

      Eines von

      • #1stringoptional

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

      • #2anyoptional

        always ""

  • occurred_atstring (utc-second)Pflicht

    pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

  • emitted_atstring (utc-second)Pflicht

    pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

  • monotonic_since_boot_msintegerPflicht

    0 to 9007199254740991

  • seqobjectPflicht

    • stream_idstringPflicht

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

    • nintegerPflicht

      1 to 9007199254740991

  • meter_epochstringPflicht

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

  • tenant_idstringPflicht

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

  • team_idstring or nullPflicht

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

  • principal_classstringPflicht

    Erlaubte Werte: "user""service""agent"

  • principal_refstringPflicht

    Original authenticated principal reference, preserved byte-for-byte under the C0 identity grammar.

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

  • planestringPflicht

    Erlaubte Werte: "ai""agent""memory""brain"

  • operationstringPflicht

    Erlaubte Werte: "chat""embedding""audio""image""document""tool""agent_overhead""responses""decision"

  • accounting_scopestringPflicht

    Erlaubte Werte: "provider_attempt""platform_overhead""agent_aggregate"

  • model_aliasstringPflicht

    Original selected model reference, preserved byte-for-byte under the C0 model registry grammar.

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

  • model_catalog_entry_digeststringPflicht

    pattern ^[a-f0-9]{64}$

  • request_idstringPflicht

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

  • run_idstring or nullPflicht

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

  • agent_idstring or nullPflicht

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

  • agent_spec_digeststring or nullPflicht

    pattern ^[a-f0-9]{64}$

  • quantitiesarray of objectPflicht

    at most 16 items

    • unitstringPflicht

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

    • amountstringPflicht

      pattern ^(0|[1-9][0-9]{0,17})(\.[0-9]{0,8}[1-9])?$

  • measurementstringPflicht

    Erlaubte Werte: "measured""estimated""unknown"

  • measurement_reasonstring or nullPflicht

    Erlaubte Werte: "coarse_counter""provider_estimate""final_usage_missing""meter_loss""canceled""implausible_count"

  • duration_msinteger or nullPflicht

    0 to 9007199254740991

  • ttft_msinteger or nullPflicht

    0 to 9007199254740991

  • request_countintegerPflicht

    0 to 9007199254740991

  • tool_call_countintegerPflicht

    0 to 9007199254740991

  • outcome_classstringPflicht

    Erlaubte Werte: "success""error""canceled""unknown"

  • data_classificationstringPflicht

    Erlaubte Werte: "public""internal""restricted"

  • routing_inputsobjectPflicht

    • rule_idsarray of stringPflicht

      at most 16 items

    • classification_labelstringPflicht

      Erlaubte Werte: "public""internal""restricted"

    • priority_groupstringPflicht

      Erlaubte Werte: "low""normal""high"

  • routing_inputs_digeststringPflicht

    pattern ^[a-f0-9]{64}$

  • bundle_versionintegerPflicht

    1 to 9007199254740991

  • bundle_digeststringPflicht

    pattern ^[a-f0-9]{64}$

• 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:

  Weiterlesen

  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.

  Weiterlesen

  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

  The credential is valid but may not do this here; the request is refused by the request boundary before the handler runs, and `error.code` says which refusal. An operation may add codes of its own.

  Weiterlesen

  Codes: policy-denied (no role of the caller holds the permission the operation needs, or the credential class may not call it: a personal API key outside inference and MCP, a route that needs a signed-in person, the one-shot installation credential outside its three steps), tenant-mismatch (the organization a path, query, body or X-Tenant header names is not the caller's own), organization-provisioning, organization-suspended, organization-disabled, organization-deleted (the state of the caller's organization), user-disabled, residency-mismatch (the organization lives on another plane), organization-selection-required (a caller with more than one organization, or a platform operator, must name one in X-Organization-Id), organization-not-selectable, no-active-organization-membership, team-not-selectable (the X-Organization-Id or X-Team-Id the caller sent does not name an organization or team it may act in), identity-managed-by-provider (a person who is not a platform operator changes an organization's status, which belongs to the identity provider), support-session-required (a platform operator reads an organization's data without an open support session)

• 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.

Ingest one C2 usage record

Anmeldedaten

API-Key

Berechtigung

usage.manage

Request-Body

Body bis 1 MiB

curl -X POST "https://console.eu.ccsio.ai/metering/v1/usage" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "schema_version": null,
  "event_id": "string",
  "idempotency_key": {
    "tenant_id": "string",
    "plane_instance_id": "string",
    "request_or_run_id": "string",
    "attempt": 0,
    "provider_response_id": "string"
  },
  "occurred_at": "string",
  "emitted_at": "string",
  "monotonic_since_boot_ms": 0,
  "seq": {
    "stream_id": "string",
    "n": 0
  },
  "meter_epoch": "string",
  "tenant_id": "string",
  "team_id": "string",
  "principal_class": "user",
  "principal_ref": "string",
  "plane": "ai",
  "operation": "chat",
  "accounting_scope": "provider_attempt",
  "model_alias": "string",
  "model_catalog_entry_digest": "string",
  "request_id": "string",
  "run_id": "string",
  "agent_id": "string",
  "agent_spec_digest": "string",
  "quantities": [
    {
      "unit": "string",
      "amount": "string"
    }
  ],
  "measurement": "measured",
  "measurement_reason": "coarse_counter",
  "duration_ms": 0,
  "ttft_ms": 0,
  "request_count": 0,
  "tool_call_count": 0,
  "outcome_class": "success",
  "data_classification": "public",
  "routing_inputs": {
    "rule_ids": [
      "string"
    ],
    "classification_label": "public",
    "priority_group": "low"
  },
  "routing_inputs_digest": "string",
  "bundle_version": 0,
  "bundle_digest": "string"
}'

Parameter

Request-Body application/json

Antworten

• 200

  The usage record was ingested (or redelivered).

  Schema

  IngestResponse

  • statusstringPflicht

    The ingest result: ingested (first delivery) or redelivered (duplicate key).

    Erlaubte Werte: "ingested""redelivered"

  • event_idstringoptional

    The durable outbox row's ULID, minted at enqueue (first delivery only; omitted on redelivery; present only when usage-event emission is enabled on the serving role).

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

  • checkpointobjectoptional

    The scope's C3 checkpoint cursors (first delivery only; omitted on redelivery).

    • tenant_idstringPflicht

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

    • plane_instance_idstringPflicht

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

    • stream_idstringPflicht

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

    • contiguous_usage_throughintegerPflicht

      0 to 9007199254740991

    • usage_high_waterintegerPflicht

      0 to 9007199254740991

• 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:

  Weiterlesen

  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.

  Weiterlesen

  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

  The credential is valid but may not do this here; the request is refused by the request boundary before the handler runs, and `error.code` says which refusal. An operation may add codes of its own.

  Weiterlesen

  Codes: policy-denied (no role of the caller holds the permission the operation needs, or the credential class may not call it: a personal API key outside inference and MCP, a route that needs a signed-in person, the one-shot installation credential outside its three steps), tenant-mismatch (the organization a path, query, body or X-Tenant header names is not the caller's own), organization-provisioning, organization-suspended, organization-disabled, organization-deleted (the state of the caller's organization), user-disabled, residency-mismatch (the organization lives on another plane), organization-selection-required (a caller with more than one organization, or a platform operator, must name one in X-Organization-Id), organization-not-selectable, no-active-organization-membership, team-not-selectable (the X-Organization-Id or X-Team-Id the caller sent does not name an organization or team it may act in), identity-managed-by-provider (a person who is not a platform operator changes an organization's status, which belongs to the identity provider), support-session-required (a platform operator reads an organization's data without an open support session)

• 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.

Summarize the selected organization's usage

Anmeldedaten

API-Key

Berechtigung

Eine vonusage.read_ownusage.readplatform-usage.readsupport-access.read

curl "https://console.eu.ccsio.ai/metering/v1/usage/summary" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

Antworten

• 200

  The selected organization's usage metrics for the requested window.

  Schema

  UsageSummaryResponse

  • organization_idstringPflicht

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

  • windowobjectPflicht

    • fromstring (date-time)Pflicht

      pattern Z$

    • tostring (date-time)Pflicht

      pattern Z$

  • scopesarray of UsageSummaryScopePflicht

    Metrics grouped by accounting_scope; scopes are never combined into an ambiguous total.

    • accounting_scopestringPflicht

      Erlaubte Werte: "provider_attempt""platform_overhead""agent_aggregate"

    • recordsUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • request_countUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • tool_call_countUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • quantitiesarray of UsageQuantityPflicht
    • measurement_countsobjectPflicht

      • measuredUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • estimatedUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • unknownUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

    • outcome_countsobjectPflicht

      • successUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • errorUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • canceledUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • unknownUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

  • modelsarray of UsageSummaryModelPflicht

    Metrics grouped by the pair (accounting_scope, model_alias).

    • accounting_scopestringPflicht

      Erlaubte Werte: "provider_attempt""platform_overhead""agent_aggregate"

    • recordsUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • request_countUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • tool_call_countUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • quantitiesarray of UsageQuantityPflicht
    • measurement_countsobjectPflicht

      • measuredUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • estimatedUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • unknownUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

    • outcome_countsobjectPflicht

      • successUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • errorUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • canceledUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • unknownUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

    • model_aliasstringPflicht

      Original selected model reference, preserved byte-for-byte under the C0 model registry grammar.

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

  • by_principalarray of UsageSummaryPrincipalPflicht

    Metrics grouped by the pair (accounting_scope, principal_ref): who made the usage of the filtered window, each principal named (see UsageSummaryPrincipal). Ordered by request_count descending (an exact integer), then principal_ref ascending, then accounting_scope. At most 100 entries per accounting_scope (so at most 300): a scope with more principals lists its first 100 and by_principal_truncated is true. The scope totals in scopes always cover every principal.

    at most 300 items

    • accounting_scopestringPflicht

      Erlaubte Werte: "provider_attempt""platform_overhead""agent_aggregate"

    • recordsUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • request_countUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • tool_call_countUsageCountPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

    • quantitiesarray of UsageQuantityPflicht
    • measurement_countsobjectPflicht

      • measuredUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • estimatedUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • unknownUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

    • outcome_countsobjectPflicht

      • successUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • errorUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • canceledUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

      • unknownUsageCountPflicht

        An exact non-negative integer serialized as a string to avoid client precision loss.

    • principal_refstringPflicht

      The principal's authoritative reference, preserved byte-for-byte under the C0 identity grammar.

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

    • principal_classstringPflicht

      Erlaubte Werte: "user""service""agent"

    • emailstring or nullPflicht

      The principal's email address, resolved at read time; null when the principal has none (a service account), is unknown to the organization's directory, or this caller may not see another user's email.

      at most 254 characters

    • display_namestring or nullPflicht

      The principal's display name (for a service account, its name), resolved at read time; null under the same conditions as email and when the principal has none.

      at most 128 characters

  • by_principal_truncatedbooleanPflicht

    True when at least one accounting scope has more than 100 principals and by_principal lists only its first 100 (ordered by request_count descending, then principal_ref). scopes, models and series always cover every principal.

  • costobjectPflicht

    • statusstringPflicht

      Usage quantities have no authoritative pricing data; no estimated monetary total is presented.

      always "unavailable"

  • seriesarray of UsageSeriesBucketPflicht

    Ascending UTC calendar-day buckets covering the whole half-open response window. First and last bucket boundaries are clipped to the window, including fractional seconds. Every intersecting day is present, including zero days. Within each accounting scope, summing daily metrics and quantities equals the full-window scoped totals; scopes are never added together.

    at least 1 items · at most 91 items

    • windowobjectPflicht

      • fromstring (date-time)Pflicht

        pattern Z$

      • tostring (date-time)Pflicht

        pattern Z$

    • scopesarray of UsageSummaryScopePflicht

      Each requested accounting scope is present independently. An empty scope has exact zero counts, zero measurement/outcome counts, and quantities []; no units or measurements are fabricated.

      at least 1 items · at most 3 items

• 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:

  Weiterlesen

  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.

  Weiterlesen

  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

  The credential is valid but may not do this here; the request is refused by the request boundary before the handler runs, and `error.code` says which refusal. An operation may add codes of its own.

  Weiterlesen

  Codes: policy-denied (no role of the caller holds the permission the operation needs, or the credential class may not call it: a personal API key outside inference and MCP, a route that needs a signed-in person, the one-shot installation credential outside its three steps), tenant-mismatch (the organization a path, query, body or X-Tenant header names is not the caller's own), organization-provisioning, organization-suspended, organization-disabled, organization-deleted (the state of the caller's organization), user-disabled, residency-mismatch (the organization lives on another plane), organization-selection-required (a caller with more than one organization, or a platform operator, must name one in X-Organization-Id), organization-not-selectable, no-active-organization-membership, team-not-selectable (the X-Organization-Id or X-Team-Id the caller sent does not name an organization or team it may act in), identity-managed-by-provider (a person who is not a platform operator changes an organization's status, which belongs to the identity provider), support-session-required (a platform operator reads an organization's data without an open support session)

• 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

  A dependency the operation needs is not configured on this plane or could not be reached, and nothing was changed. `error.code` names it; an operation lists the ones it can answer besides the boundary's. Retry later. Codes: support-audit-unavailable (the request boundary: an operator's read under an open support session could not be recorded, so nothing was served)

{
  "organization_id": "acme",
  "window": {
    "from": "2026-10-12T00:00:00Z",
    "to": "2026-10-14T00:00:00Z"
  },
  "scopes": [
    {
      "accounting_scope": "provider_attempt",
      "records": "5",
      "request_count": "5",
      "tool_call_count": "0",
      "quantities": [
        {
          "unit": "input_tokens",
          "amount": "1840"
        },
        {
          "unit": "output_tokens",
          "amount": "3122"
        }
      ],
      "measurement_counts": {
        "measured": "5",
        "estimated": "0",
        "unknown": "0"
      },
      "outcome_counts": {
        "success": "4",
        "error": "1",
        "canceled": "0",
        "unknown": "0"
      }
    }
  ],
  "models": [
    {
      "accounting_scope": "provider_attempt",
      "model_alias": "gpt-4o",
      "records": "3",
      "request_count": "3",
      "tool_call_count": "0",
      "quantities": [
        {
          "unit": "input_tokens",
          "amount": "1200"
        },
        {
          "unit": "output_tokens",
          "amount": "3122"
        }
      ],
      "measurement_counts": {
        "measured": "3",
        "estimated": "0",
        "unknown": "0"
      },
      "outcome_counts": {
        "success": "2",
        "error": "1",
        "canceled": "0",
        "unknown": "0"
      }
    },
    {
      "accounting_scope": "provider_attempt",
      "model_alias": "embed-1",
      "records": "2",
      "request_count": "2",
      "tool_call_count": "0",
      "quantities": [
        {
          "unit": "input_tokens",
          "amount": "640"
        }
      ],
      "measurement_counts": {
        "measured": "2",
        "estimated": "0",
        "unknown": "0"
      },
      "outcome_counts": {
        "success": "2",
        "error": "0",
        "canceled": "0",
        "unknown": "0"
      }
    }
  ],
  "by_principal": [
    {
      "accounting_scope": "provider_attempt",
      "principal_ref": "svc/01K7YP2C9W4X5E8H3J6M0N1Q2R",
      "principal_class": "service",
      "email": null,
      "display_name": "billing-app",
      "records": "5",
      "request_count": "5",
      "tool_call_count": "0",
      "quantities": [
        {
          "unit": "input_tokens",
          "amount": "1840"
        },
        {
          "unit": "output_tokens",
          "amount": "3122"
        }
      ],
      "measurement_counts": {
        "measured": "5",
        "estimated": "0",
        "unknown": "0"
      },
      "outcome_counts": {
        "success": "4",
        "error": "1",
        "canceled": "0",
        "unknown": "0"
      }
    }
  ],
  "by_principal_truncated": false,
  "cost": {
    "status": "unavailable"
  },
  "series": [
    {
      "window": {
        "from": "2026-10-12T00:00:00Z",
        "to": "2026-10-13T00:00:00Z"
      },
      "scopes": [
        {
          "accounting_scope": "provider_attempt",
          "records": "3",
          "request_count": "3",
          "tool_call_count": "0",
          "quantities": [
            {
              "unit": "input_tokens",
              "amount": "1000"
            },
            {
              "unit": "output_tokens",
              "amount": "1800"
            }
          ],
          "measurement_counts": {
            "measured": "3",
            "estimated": "0",
            "unknown": "0"
          },
          "outcome_counts": {
            "success": "3",
            "error": "0",
            "canceled": "0",
            "unknown": "0"
          }
        }
      ]
    },
    {
      "window": {
        "from": "2026-10-13T00:00:00Z",
        "to": "2026-10-14T00:00:00Z"
      },
      "scopes": [
        {
          "accounting_scope": "provider_attempt",
          "records": "2",
          "request_count": "2",
          "tool_call_count": "0",
          "quantities": [
            {
              "unit": "input_tokens",
              "amount": "840"
            },
            {
              "unit": "output_tokens",
              "amount": "1322"
            }
          ],
          "measurement_counts": {
            "measured": "2",
            "estimated": "0",
            "unknown": "0"
          },
          "outcome_counts": {
            "success": "1",
            "error": "1",
            "canceled": "0",
            "unknown": "0"
          }
        }
      ]
    }
  ]
}

List recent usage for the selected organization

Anmeldedaten

API-Key

Berechtigung

Eine vonusage.read_ownusage.readsupport-access.read

curl "https://console.eu.ccsio.ai/metering/v1/usage/page" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

Antworten

• 200

  A page of usage evidence for the selected organization.

  Schema

  UsagePageResponse

  • organization_idstringPflicht

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

  • windowobjectPflicht

    • fromstring (date-time)Pflicht

      pattern Z$

    • tostring (date-time)Pflicht

      pattern Z$

  • recordsarray of RecentUsageRecordPflicht

    at most 100 items

    • event_idstringPflicht

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

    • occurred_atstring (utc-second)Pflicht

      pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

    • request_idstringPflicht

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

    • model_aliasstringPflicht

      Original selected model reference, preserved byte-for-byte under the C0 model registry grammar.

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

    • provider_classanyPflicht

      Erlaubte Werte: "CCSIO_INFERENCE""CUSTOMER_HOSTED""EXTERNAL_MANAGED"null

    • operationstringPflicht

      Erlaubte Werte: "chat""embedding""audio""image""document""tool""agent_overhead""responses""decision"

    • accounting_scopestringPflicht

      Erlaubte Werte: "provider_attempt""platform_overhead""agent_aggregate"

    • measurementstringPflicht

      Erlaubte Werte: "measured""estimated""unknown"

    • outcome_classstringPflicht

      Erlaubte Werte: "success""error""canceled""unknown"

    • request_duration_msinteger or nullPflicht

      Whole router request timing, shared by all attempt records; absent on legacy records.

      0 to 9007199254740991

    • quantitiesarray of UsageQuantityPflicht
    • request_countstringPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

      pattern ^(0|[1-9][0-9]*)$

    • tool_call_countstringPflicht

      An exact non-negative integer serialized as a string to avoid client precision loss.

      pattern ^(0|[1-9][0-9]*)$

  • next_cursorstring or nullPflicht

    Opaque continuation cursor bound to the selected organization, frozen window, exact model reference and accounting scope; null when there are no more records.

    at most 2048 characters

• 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:

  Weiterlesen

  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.

  Weiterlesen

  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

  The credential is valid but may not do this here; the request is refused by the request boundary before the handler runs, and `error.code` says which refusal. An operation may add codes of its own.

  Weiterlesen

  Codes: policy-denied (no role of the caller holds the permission the operation needs, or the credential class may not call it: a personal API key outside inference and MCP, a route that needs a signed-in person, the one-shot installation credential outside its three steps), tenant-mismatch (the organization a path, query, body or X-Tenant header names is not the caller's own), organization-provisioning, organization-suspended, organization-disabled, organization-deleted (the state of the caller's organization), user-disabled, residency-mismatch (the organization lives on another plane), organization-selection-required (a caller with more than one organization, or a platform operator, must name one in X-Organization-Id), organization-not-selectable, no-active-organization-membership, team-not-selectable (the X-Organization-Id or X-Team-Id the caller sent does not name an organization or team it may act in), identity-managed-by-provider (a person who is not a platform operator changes an organization's status, which belongs to the identity provider), support-session-required (a platform operator reads an organization's data without an open support session)

• 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

  A dependency the operation needs is not configured on this plane or could not be reached, and nothing was changed. `error.code` names it; an operation lists the ones it can answer besides the boundary's. Retry later. Codes: support-audit-unavailable (the request boundary: an operator's read under an open support session could not be recorded, so nothing was served)

{
  "organization_id": "acme",
  "window": {
    "from": "2026-10-12T00:00:00Z",
    "to": "2026-10-14T00:00:00Z"
  },
  "records": [
    {
      "event_id": "event.req-01k7yqa2c4e6g8j0m2p4r6t8v0",
      "occurred_at": "2026-10-13T16:41:02Z",
      "request_id": "req-01k7yqa2c4e6g8j0m2p4r6t8v0",
      "model_alias": "gpt-4o",
      "provider_class": "CCSIO_INFERENCE",
      "operation": "chat",
      "accounting_scope": "provider_attempt",
      "quantities": [
        {
          "unit": "input_tokens",
          "amount": "412"
        },
        {
          "unit": "output_tokens",
          "amount": "697"
        }
      ],
      "measurement": "measured",
      "outcome_class": "success",
      "request_duration_ms": 1840,
      "request_count": "1",
      "tool_call_count": "0"
    },
    {
      "event_id": "event.req-01k7yq5v8n3m4p7r2s6t9w0x1y",
      "occurred_at": "2026-10-13T09:14:27Z",
      "request_id": "req-01k7yq5v8n3m4p7r2s6t9w0x1y",
      "model_alias": "embed-1",
      "provider_class": "CCSIO_INFERENCE",
      "operation": "embedding",
      "accounting_scope": "provider_attempt",
      "quantities": [
        {
          "unit": "input_tokens",
          "amount": "320"
        }
      ],
      "measurement": "measured",
      "outcome_class": "success",
      "request_duration_ms": 96,
      "request_count": "1",
      "tool_call_count": "0"
    }
  ],
  "next_cursor": "eyJ2Ijo0LCJ0ZW5hbnQiOiJhY21lIiwid2luZG93Ijp7ImZyb20iOiIyMDI2LTEwLTEyVDAwOjAwOjAwWiIsInRvIjoiMjAyNi0xMC0xNFQwMDowMDowMFoifSwiYWZ0ZXIiOnsiYXQiOiIyMDI2LTEwLTEzVDA5OjE0OjI3WiIsInBsYW5lIjoicGxhbmUuZXUiLCJyZXF1ZXN0IjoicmVxLTAxazd5cTV2OG4zbTRwN3IyczZ0OXcweDF5IiwiYXR0ZW1wdCI6MSwicHJvdmlkZXIiOiJcdTAwM2NudWxsXHUwMDNlIn0sInByaW5jaXBhbCI6InN2Yy8wMUs3WVAyQzlXNFg1RThIM0o2TTBOMVEyUiIsImFwaV9rZXlfaWQiOiIwMUs3WVAzQTVUOFEyTjZSNFYxVzlYWkI3RCJ9"
}