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

Memory exports

Export a member's memories.

Documentation menu

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

POST/memory/v1/exports

Ask for an export of the caller's memories

Credential
API key
Permission
memory.use

Queues an export of the caller's own user-scope memories and answers 202 with it, pending. Poll the export until it is ready. No body. Exporting works while memory is paused or disabled.

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

  • 202

    The export, pending.

    Schema
    MemoryExport
    • idstringrequired

      Opaque; core generates it as `x-` plus a lowercase ULID.

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

    • statestringrequired

      Allowed values: "pending""ready""failed""expired"

    • created_atstring (date-time)required
    • expires_atstring (date-time)optional

      When the file is deleted. Present once the export is ready.

    • download_urlstring (uri)optional

      Present only while state is ready: a presigned, short-lived address of the file. It is a bearer token by itself: it must never be logged, cached or shared. Read the export again for a fresh one.

    • errorobject or nulloptional

      Present only when state is failed.

      • codestringrequired

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

      • categorystringrequired

        Allowed values: "client""server""external""unknown"

      • messagestringrequired
      • actionstringoptional
      • request_idstringoptional
  • 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

GET/memory/v1/exports/{export}

Read an export

Credential
API key
Permission
memory.use

Answers an export the caller asked for. While its state is `ready` it carries a `download_url`; the address is a bearer token by itself and must never be logged. After `expires_at` the state is `expired` and the file is gone. An export the caller did not ask for is answered as one that does not exist.

curl
curl "https://api.latam.ccsio.ai/memory/v1/exports/{export}" \
  -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.

export
required
pathstring

The export's id.

Responses

  • 200

    The export.

    Schema
    MemoryExport
    • idstringrequired

      Opaque; core generates it as `x-` plus a lowercase ULID.

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

    • statestringrequired

      Allowed values: "pending""ready""failed""expired"

    • created_atstring (date-time)required
    • expires_atstring (date-time)optional

      When the file is deleted. Present once the export is ready.

    • download_urlstring (uri)optional

      Present only while state is ready: a presigned, short-lived address of the file. It is a bearer token by itself: it must never be logged, cached or shared. Read the export again for a fresh one.

    • errorobject or nulloptional

      Present only when state is failed.

      • codestringrequired

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

      • categorystringrequired

        Allowed values: "client""server""external""unknown"

      • messagestringrequired
      • actionstringoptional
      • request_idstringoptional
  • 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

    No export with that id that the caller asked for; or the plane has no memory database configured (MEMORY_DATABASE_URL), so the Memory M1 routes are off. Codes: export-not-found, 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