Saltar al contenido principal
DocumentaciónBrain · api.latam.ccsio.ai

Brain usage

The capacity and the sync health of the Brain.

Menú de la documentación

Las descripciones de las operaciones y los campos son las del contrato, en inglés.

GET/brain/v1/usage

Read the Brain's usage

Credencial
API key
Permiso
brain.read

Answers what the Brain holds against its capacity, the number of documents and the sources by state. It reads no document.

curl
curl "https://api.latam.ccsio.ai/brain/v1/usage" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parámetros

NombreEnDescripción
X-Request-ID
opcional
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.

Respuestas

  • 200

    The usage.

    Esquema
    BrainUsage
    • used_bytesintegerobligatorio

      at least 0

    • limit_bytesinteger or nullobligatorio

      The plan's limit plus any `brain_capacity` entitlement; null means unlimited (still measured).

      at least 0

    • percentnumber or nullobligatorio

      used_bytes over limit_bytes as a percentage; null when limit_bytes is null. At 100 new ingestion is refused with 409 brain-capacity-exceeded; reads and search keep working and nothing is deleted.

      at least 0

    • documentsintegerobligatorio

      at least 0

    • sourcesobjectobligatorio
      • pendingintegerobligatorio

        at least 0

      • syncingintegerobligatorio

        at least 0

      • readyintegerobligatorio

        at least 0

      • failedintegerobligatorio

        at least 0

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

    Leer más

    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.

    Leer más

    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 `brain.read` in the organization. Codes: policy-denied, brain-disabled (the organization has no Brain capacity)

  • 404

    The plane has no Brain database configured (BRAIN_DATABASE_URL), so every Brain route is off. Codes: brain-not-enabled

  • 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. Codes: internal-error

Generado a partir de los contratos de la plataforma en el commit 5954fbc1.

Explora la plataforma

Obtén tu primera key API

El registro está abierto. Cuatro pasos hasta tu primera llamada: crea tu cuenta, crea tu organización, crea tu API key y empieza a usarla.

  1. 01Crea tu cuenta
  2. 02Crea tu organización
  3. 03Crea tu API key
  4. 04Empieza a usarla