Skip to main content
DocumentationMemory · api.latam.ccsio.ai

Memory settings

A member's own memory settings.

Documentation menu

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

GET/memory/v1/me/settings

Read the caller's memory settings

Credential
API key
Permission
memory.use

Answers the caller's own settings. A person who never saved any reads paused false and agents_may_write true.

curl
curl "https://api.latam.ccsio.ai/memory/v1/me/settings" \
  -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.

Responses

  • 200

    The caller's settings.

    Schema
    MemorySettings
    • pausedbooleanrequired

      While true nothing new is saved for the caller and nothing is recalled for them: creating a memory and recalling answer 409 memory-paused. Reading, editing, exporting and erasing keep working. Default false.

    • agents_may_writebooleanrequired

      Whether the caller's agents (service accounts, MCP tools) may write active memories to their own scope. Default true. While it is false, or while the organization's policy sets agents_may_write_user_scope to false, what an agent writes to the caller's scope is stored as `proposed` and the caller accepts or rejects it.

  • 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 `memory.use` in the organization. Codes: policy-denied

  • 404

    The plane has no memory database configured (MEMORY_DATABASE_URL), so the Memory M1 routes are off. Codes: memory-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

PUT/memory/v1/me/settings

Replace the caller's memory settings

Credential
API key
Permission
memory.use
Request body
Body up to 1 MiB

Replaces the caller's own settings and answers them. Both members are required. The body is capped at 1048576 bytes.

curl
curl -X PUT "https://api.latam.ccsio.ai/memory/v1/me/settings" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "paused": false,
  "agents_may_write": false
}'
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.

Request body application/json

MemorySettings
  • pausedbooleanrequired

    While true nothing new is saved for the caller and nothing is recalled for them: creating a memory and recalling answer 409 memory-paused. Reading, editing, exporting and erasing keep working. Default false.

  • agents_may_writebooleanrequired

    Whether the caller's agents (service accounts, MCP tools) may write active memories to their own scope. Default true. While it is false, or while the organization's policy sets agents_may_write_user_scope to false, what an agent writes to the caller's scope is stored as `proposed` and the caller accepts or rejects it.

Responses

  • 200

    The caller's settings.

    Schema
    MemorySettings
    • pausedbooleanrequired

      While true nothing new is saved for the caller and nothing is recalled for them: creating a memory and recalling answer 409 memory-paused. Reading, editing, exporting and erasing keep working. Default false.

    • agents_may_writebooleanrequired

      Whether the caller's agents (service accounts, MCP tools) may write active memories to their own scope. Default true. While it is false, or while the organization's policy sets agents_may_write_user_scope to false, what an agent writes to the caller's scope is stored as `proposed` and the caller accepts or rejects it.

  • 400

    A body that is not strict JSON, or a member missing. 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 `memory.use` in the organization. Codes: policy-denied

  • 404

    The plane has no memory database configured (MEMORY_DATABASE_URL), so the Memory M1 routes are off. Codes: memory-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