Skip to main content
DocumentationBrain · api.us.ccsio.ai

Brain pages

List and read the compiled pages (read-only in B1).

Documentation menu

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

GET/brain/v1/pages

List the pages

Credential
API key
Permission
brain.read

Lists the pages of the spaces the caller's audience reaches, pinned first and then newest updated_at first, without their bodies. In B1 pages come only from git sources in `pages` mode and are read-only here. A filter narrows the list and never widens it. Draft and deprecated pages are listed (filter with `status`); search and context leave them out.

curl
curl "https://api.us.ccsio.ai/brain/v1/pages" \
  -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.

space
optional
querystring

Only this space.

kind
optional
querystring

Only pages of this kind.

project
optional
querystring

Only pages that apply to this project, and the ones that apply to the whole space.

status
optional
querystring

Only pages with this status.

cursor
optional
querystring

The `next_cursor` of the previous page; absent starts at the first item. A cursor that this plane did not write is refused with 400 invalid-request.

limit
optional
queryinteger

The largest page, 1 to 100. Default 50.

Responses

  • 200

    One page of pages.

    Schema
    BrainPageList
    • pagesarray of BrainPageSummaryrequired

      Pinned first, then newest updated_at first.

      • idstringrequired

        An id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.

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

      • spacestringrequired

        An id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.

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

      • kindstringrequired

        Allowed values: "overview""standard""blueprint""decision""runbook""procedure""glossary""faq"

      • titlestringrequired

        1 to 300 characters

      • applies_toarray of BrainLabelrequired

        Project labels; empty means the whole space.

        at most 50 items

      • ownerstring or nullrequired

        `user:<email>`; null when the page names none.

        pattern ^user:[^@\s]+@[^@\s]+$

      • review_everystring or nullrequired

        How often the owner re-verifies the page, such as `180d`; null when never.

        pattern ^[1-9][0-9]{0,3}d$

      • pinnedbooleanrequired

        A pinned page is returned whole by the context route.

      • statusstringrequired

        Draft and deprecated pages are not searched and not served in context.

        Allowed values: "draft""published""deprecated"

      • skillobject or nullrequired

        Set when a procedure page is published as an Agent Skill.

        • namestringrequired

          pattern ^[a-z0-9-]{1,64}$

        • descriptionstringrequired

          1 to 1024 characters

      • verified_atstring (date-time) or nullrequired

        Set by an owner's verification or by a merge in a git source, never by a model; null until then.

      • stalebooleanrequired

        True when a document the page cites changed after verified_at. A stale page drops in ranking until its owner verifies or edits it.

      • sourcestring or nullrequired

        The git source the page comes from. Pages are read-only in B1: they exist only in a git source in `pages` mode.

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

      • pathstring or nullrequired

        The path of the file in the repository.

        at most 1024 characters

      • revisionintegerrequired

        Moves with every change of the file in the source.

        at least 1

      • updated_atstring (date-time)required
    • next_cursorstring or nullrequired
  • 400

    A filter or a limit outside its range, a cursor this plane did not write, an unknown query parameter. Codes: invalid-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 `brain.read` in the organization. Codes: policy-denied, brain-disabled (the organization has no Brain capacity)

  • 404

    The space does not exist or is not one the caller's audience reaches; or the plane has no Brain database configured (BRAIN_DATABASE_URL), so every Brain route is off. Codes: space-not-found, 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

GET/brain/v1/pages/{page}

Read a page

Credential
API key
Permission
brain.read

Answers one page with its body. Read-only in B1.

curl
curl "https://api.us.ccsio.ai/brain/v1/pages/{page}" \
  -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.

page
required
pathstring

The page's id. A page in a space the caller's audience does not reach is answered as one that does not exist.

Responses

  • 200

    The page.

    Schema
    BrainPage
    • idstringrequired

      An id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.

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

    • spacestringrequired

      An id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.

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

    • kindstringrequired

      Allowed values: "overview""standard""blueprint""decision""runbook""procedure""glossary""faq"

    • titlestringrequired

      1 to 300 characters

    • applies_toarray of BrainLabelrequired

      Project labels; empty means the whole space.

      at most 50 items

    • ownerstring or nullrequired

      `user:<email>`; null when the page names none.

      pattern ^user:[^@\s]+@[^@\s]+$

    • review_everystring or nullrequired

      How often the owner re-verifies the page, such as `180d`; null when never.

      pattern ^[1-9][0-9]{0,3}d$

    • pinnedbooleanrequired

      A pinned page is returned whole by the context route.

    • statusstringrequired

      Draft and deprecated pages are not searched and not served in context.

      Allowed values: "draft""published""deprecated"

    • skillobject or nullrequired

      Set when a procedure page is published as an Agent Skill.

      • namestringrequired

        pattern ^[a-z0-9-]{1,64}$

      • descriptionstringrequired

        1 to 1024 characters

    • verified_atstring (date-time) or nullrequired

      Set by an owner's verification or by a merge in a git source, never by a model; null until then.

    • stalebooleanrequired

      True when a document the page cites changed after verified_at. A stale page drops in ranking until its owner verifies or edits it.

    • sourcestring or nullrequired

      The git source the page comes from. Pages are read-only in B1: they exist only in a git source in `pages` mode.

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

    • pathstring or nullrequired

      The path of the file in the repository.

      at most 1024 characters

    • revisionintegerrequired

      Moves with every change of the file in the source.

      at least 1

    • updated_atstring (date-time)required
    • bodystringrequired

      The Markdown body, without the front matter.

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

  • 404

    The page does not exist or is not one the caller's audience reaches; or the plane has no Brain database configured (BRAIN_DATABASE_URL), so every Brain route is off. Codes: page-not-found, 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

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