Die Beschreibungen der Operationen und Felder stammen aus dem Vertrag und sind auf Englisch.
/brain/v1/spacesList the spaces
- Anmeldedaten
- API-Key
- Berechtigung
brain.read
Lists the spaces the caller's audience reaches: the organization's spaces and the spaces of the teams the caller belongs to, oldest first. The organization is the caller's own, from the verified principal.
curl "https://api.eu.ccsio.ai/brain/v1/spaces" \
-H "Authorization: Bearer $CCSIO_API_KEY"Parameter
| Name | In | Beschreibung |
|---|---|---|
X-Request-IDoptional | header | string 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. |
cursoroptional | query | string 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. |
limitoptional | query | integer The largest page, 1 to 100. Default 50. |
Antworten
- 200
One page of spaces.
Schema
BrainSpaceListspacesarray of BrainSpacePflichtThe spaces the caller's audience reaches, oldest first.
idstringPflichtAn id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.
pattern ^[a-z][a-z0-9._-]{0,127}$
namestringPflicht1 to 120 characters
kindstringPflichtWho the space is for. `organization`: every member. `team`: that team's members. More kinds may be added later (a space of named members is planned): a client must tolerate a value it does not know and treat it as a space it can read but not describe.
teamstring or nullPflichtThe team id for kind team; null for every other kind.
pattern ^[a-z][a-z0-9._-]{0,127}$
created_atstring (date-time)Pflicht
next_cursorstring or nullPflichtThe cursor of the next page; null on the last one.
- 400
A limit outside 1 to 100, 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:
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
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
/brain/v1/spacesCreate a space
- Anmeldedaten
- API-Key
- Berechtigung
brain.manage- Request-Body
- Body bis 1 MiB
Creates a space and answers 201 with it. An organization space needs `brain.manage` in the organization; a team space is also open to an admin of that team. The body is capped at 1048576 bytes.
curl -X POST "https://api.eu.ccsio.ai/brain/v1/spaces" \
-H "Authorization: Bearer $CCSIO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"kind": "organization"
}'Parameter
| Name | In | Beschreibung |
|---|---|---|
X-Request-IDoptional | header | string 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. |
Request-Body application/json
namestringPflicht1 to 120 characters
kindstringPflichtErlaubte Werte:
"organization""team"teamstringoptionalRequired for kind team and refused for kind organization.
Antworten
- 201
The space.
Schema
BrainSpaceidstringPflichtAn id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.
pattern ^[a-z][a-z0-9._-]{0,127}$
namestringPflicht1 to 120 characters
kindstringPflichtWho the space is for. `organization`: every member. `team`: that team's members. More kinds may be added later (a space of named members is planned): a client must tolerate a value it does not know and treat it as a space it can read but not describe.
teamstring or nullPflichtThe team id for kind team; null for every other kind.
pattern ^[a-z][a-z0-9._-]{0,127}$
created_atstring (date-time)Pflicht
- 400
A body that is not strict JSON, a name that is empty or over 120 characters, a team missing for kind team or sent with kind organization. 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:
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
No role of the caller holds `brain.manage` in the organization, or in the team of the space. 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
/brain/v1/spaces/{space}Read a space
- Anmeldedaten
- API-Key
- Berechtigung
brain.read
Answers one space.
curl "https://api.eu.ccsio.ai/brain/v1/spaces/{space}" \
-H "Authorization: Bearer $CCSIO_API_KEY"Parameter
| Name | In | Beschreibung |
|---|---|---|
X-Request-IDoptional | header | string 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. |
spacePflicht | path | string The space's id. A space the caller's audience does not reach is answered as one that does not exist. |
Antworten
- 200
The space.
Schema
BrainSpaceidstringPflichtAn id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.
pattern ^[a-z][a-z0-9._-]{0,127}$
namestringPflicht1 to 120 characters
kindstringPflichtWho the space is for. `organization`: every member. `team`: that team's members. More kinds may be added later (a space of named members is planned): a client must tolerate a value it does not know and treat it as a space it can read but not describe.
teamstring or nullPflichtThe team id for kind team; null for every other kind.
pattern ^[a-z][a-z0-9._-]{0,127}$
created_atstring (date-time)Pflicht
- 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
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
/brain/v1/spaces/{space}Rename a space
- Anmeldedaten
- API-Key
- Berechtigung
brain.manage- Request-Body
- Body bis 1 MiB
Renames a space and answers it. The kind and the team of a space never change. The body is capped at 1048576 bytes.
curl -X PATCH "https://api.eu.ccsio.ai/brain/v1/spaces/{space}" \
-H "Authorization: Bearer $CCSIO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'Parameter
| Name | In | Beschreibung |
|---|---|---|
X-Request-IDoptional | header | string 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. |
spacePflicht | path | string The space's id. A space the caller's audience does not reach is answered as one that does not exist. |
Request-Body application/json
namestringPflicht1 to 120 characters
Antworten
- 200
The space.
Schema
BrainSpaceidstringPflichtAn id generated by core: URL-safe, matching the C6 identifier pattern, and opaque to clients.
pattern ^[a-z][a-z0-9._-]{0,127}$
namestringPflicht1 to 120 characters
kindstringPflichtWho the space is for. `organization`: every member. `team`: that team's members. More kinds may be added later (a space of named members is planned): a client must tolerate a value it does not know and treat it as a space it can read but not describe.
teamstring or nullPflichtThe team id for kind team; null for every other kind.
pattern ^[a-z][a-z0-9._-]{0,127}$
created_atstring (date-time)Pflicht
- 400
A body that is not strict JSON or a name that is empty or over 120 characters. 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:
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
No role of the caller holds `brain.manage` in the organization, or in the team of the space. 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
/brain/v1/spaces/{space}Delete a space
- Anmeldedaten
- API-Key
- Berechtigung
brain.manage
Deletes a space and everything in it: its sources, documents and pages, their chunks and search data in the same transaction, and the stored originals. Nothing can be recovered; backups keep the data for their retention. Answers 204. Deleting frees the capacity at once.
curl -X DELETE "https://api.eu.ccsio.ai/brain/v1/spaces/{space}" \
-H "Authorization: Bearer $CCSIO_API_KEY"Parameter
| Name | In | Beschreibung |
|---|---|---|
X-Request-IDoptional | header | string 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. |
spacePflicht | path | string The space's id. A space the caller's audience does not reach is answered as one that does not exist. |
Antworten
- 204
The space and everything in it are deleted.
- 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
No role of the caller holds `brain.manage` in the organization, or in the team of the space. 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
Erzeugt aus den Plattformverträgen beim Commit 5954fbc1.