Zum Hauptinhalt springen
DokumentationMemory · api.eu.ccsio.ai

Memory proposals

Review the memories that wait for a decision.

Menü der Dokumentation

Die Beschreibungen der Operationen und Felder stammen aus dem Vertrag und sind auf Englisch.

GET/memory/v1/proposals

List the proposals the caller may decide on

Anmeldedaten
API-Key
Berechtigung
Eine vonmemory.usememory.reviewmemory.manage

Lists the proposed memories the caller may accept or reject, newest first, as summaries: the caller's own proposals, the ones of the teams they review with `memory.review`, and, with `memory.manage`, the organization's. A proposal made in a personal scope is never listed to anyone but its owner.

curl
curl "https://api.eu.ccsio.ai/memory/v1/proposals" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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.

owner
optional
querystring

Only memories of this owner kind. Absent lists every owner the caller may read.

team
optional
querystring

Only memories of this team, which the caller must belong to.

project
optional
querystring

Only memories with this project label. A label narrows reads and grants no access.

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.

Antworten

  • 200

    One page of proposals.

    Schema
    MemoryList
    • memoriesarray of MemorySummaryPflicht
      • idstringPflicht

        A memory's id. It is the entry's C6 fact id, so it matches the C6 identifier pattern; core generates it as `m-` plus a lowercase ULID. Clients treat it as opaque.

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

      • ownerobjectPflicht

        Whose memory it is, as stored. `id` is the id of the owner: the person for user, the team for team, the organization for org, the service account for agent. The organization is never part of an owner: it is the caller's own, from the verified principal.

        • kindstringPflicht

          Erlaubte Werte: "user""team""org""agent"

        • idstringPflicht

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

        • teamstring or nullPflicht

          The team id for kind team; null for every other kind.

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

      • projectstring or nullPflicht

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

      • sessionstring or nullPflicht

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

      • typeMemoryType or nullPflicht

        null for an entry stored through the C6 entries routes, which carry no type.

      • importanceintegerPflicht

        1 to 5

      • pinnedbooleanPflicht
      • provenanceobjectPflicht

        Where a memory came from and how far it is trusted. It is decided by the surface that wrote the memory, never by the credential type and never by the body: a person calling the REST /memory/v1 routes is `user` and `user-confirmed`, whether they use a session or their own personal API key; a service-account principal (agent owners) and the MCP tools (`memory_save`, M2) are `agent` and `agent-written`; an extraction job is `extraction` and `extracted`. A memory whose trust is `extracted` is never served in a shared scope until a person confirms it.

        • sourcestringPflicht

          Erlaubte Werte: "user""agent""extraction""import"

        • truststringPflicht

          Erlaubte Werte: "user-confirmed""agent-written""extracted"

        • agentstringoptional

          The agent that wrote the memory, when source is agent.

          at most 128 characters

        • evidencearray of stringoptional

          References to where the memory came from, such as `conversation:<id>`. Omitted when there are none.

          at most 32 items

      • statestringPflicht

        active: served by recall. proposed: waits for a reviewer or the owner to accept it and is never served. superseded: replaced by a newer memory (`superseded_by`), kept in history until erased, never served. erased: the terminal tombstone; the text is gone and only a journaled receipt remains.

        Erlaubte Werte: "active""proposed""superseded""erased"

      • valid_fromstring (date-time)Pflicht
      • superseded_byMemoryId or nullPflicht

        A memory's id. It is the entry's C6 fact id, so it matches the C6 identifier pattern; core generates it as `m-` plus a lowercase ULID. Clients treat it as opaque.

      • superseded_atstring (date-time) or nullPflicht
      • expires_atstring (date-time) or nullPflicht
      • revisionintegerPflicht

        1 when the memory is created; every edit adds one.

        at least 1

      • created_atstring (date-time)Pflicht
      • updated_atstring (date-time)Pflicht
      • snippetstringPflicht

        The start of the text, at most 200 characters. The full text is never in a list: read the memory.

        at most 200 characters

      • subjectstringoptional

        The end user of the application this agent memory is about. Present only on a memory the caller's agent owns that carries one; omitted otherwise.

        pattern ^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$

    • next_cursorstring or nullPflicht

      The cursor of the next page; null on the last one.

  • 400

    A filter or a limit outside its range, a cursor this plane did not write. 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 `memory.use` (own scopes), `memory.review` (a team they review) or `memory.manage` (the organization's scope). Codes: policy-denied, memory-scope-forbidden (the caller may not act in the owner scope the request names, or does not own the memory)

  • 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

POST/memory/v1/proposals/{memory}/accept

Accept a proposal

Anmeldedaten
API-Key
Berechtigung
Eine vonmemory.usememory.reviewmemory.manage
Request-Body
Body bis 1 MiB

Makes a proposed memory active, optionally with an edited `content`, and answers 200 with it. The memory becomes served by recall. A memory that is not a proposal the caller may decide on is 404 memory-not-found. Accepting can be refused with 409 memory-capacity-exceeded; nothing is deleted to make room. The body is optional and capped at 1048576 bytes.

curl
curl -X POST "https://api.eu.ccsio.ai/memory/v1/proposals/{memory}/accept" \
  -H "Authorization: Bearer $CCSIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Aus den Pflichtfeldern des Schemas erzeugt: ersetze die Werte.

Parameter

NameInBeschreibung
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.

memory
Pflicht
pathstring

The memory's id. A value outside the C6 identifier pattern, or one the caller may not read, is answered as a memory that does not exist.

Request-Body application/json

MemoryProposalAcceptRequest
  • contentstringoptional

    The text to store instead of the proposed one. Absent keeps the proposed text.

    1 to 8000 characters

Antworten

  • 200

    The memory, now active.

    Schema
    Memory
    • idstringPflicht

      A memory's id. It is the entry's C6 fact id, so it matches the C6 identifier pattern; core generates it as `m-` plus a lowercase ULID. Clients treat it as opaque.

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

    • ownerobjectPflicht

      Whose memory it is, as stored. `id` is the id of the owner: the person for user, the team for team, the organization for org, the service account for agent. The organization is never part of an owner: it is the caller's own, from the verified principal.

      • kindstringPflicht

        Erlaubte Werte: "user""team""org""agent"

      • idstringPflicht

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

      • teamstring or nullPflicht

        The team id for kind team; null for every other kind.

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

    • projectstring or nullPflicht

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

    • sessionstring or nullPflicht

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

    • typestring or nullPflicht

      null for an entry stored through the C6 entries routes, which carry no type.

      Erlaubte Werte: "preference""fact""decision""event""task-state""lesson"

    • importanceintegerPflicht

      1 to 5

    • pinnedbooleanPflicht
    • provenanceobjectPflicht

      Where a memory came from and how far it is trusted. It is decided by the surface that wrote the memory, never by the credential type and never by the body: a person calling the REST /memory/v1 routes is `user` and `user-confirmed`, whether they use a session or their own personal API key; a service-account principal (agent owners) and the MCP tools (`memory_save`, M2) are `agent` and `agent-written`; an extraction job is `extraction` and `extracted`. A memory whose trust is `extracted` is never served in a shared scope until a person confirms it.

      • sourcestringPflicht

        Erlaubte Werte: "user""agent""extraction""import"

      • truststringPflicht

        Erlaubte Werte: "user-confirmed""agent-written""extracted"

      • agentstringoptional

        The agent that wrote the memory, when source is agent.

        at most 128 characters

      • evidencearray of stringoptional

        References to where the memory came from, such as `conversation:<id>`. Omitted when there are none.

        at most 32 items

    • statestringPflicht

      active: served by recall. proposed: waits for a reviewer or the owner to accept it and is never served. superseded: replaced by a newer memory (`superseded_by`), kept in history until erased, never served. erased: the terminal tombstone; the text is gone and only a journaled receipt remains.

      Erlaubte Werte: "active""proposed""superseded""erased"

    • valid_fromstring (date-time)Pflicht
    • superseded_bystring or nullPflicht

      A memory's id. It is the entry's C6 fact id, so it matches the C6 identifier pattern; core generates it as `m-` plus a lowercase ULID. Clients treat it as opaque.

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

    • superseded_atstring (date-time) or nullPflicht
    • expires_atstring (date-time) or nullPflicht
    • revisionintegerPflicht

      1 when the memory is created; every edit adds one.

      at least 1

    • created_atstring (date-time)Pflicht
    • updated_atstring (date-time)Pflicht
    • contentstringPflicht

      1 to 8000 characters

    • subjectstringoptional

      The end user of the application this agent memory is about. Present only on a memory the caller's agent owns that carries one; omitted otherwise.

      pattern ^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$

  • 400

    A body that is not strict JSON or a content over 8000 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 `memory.use` (own scopes), `memory.review` (a team they review) or `memory.manage` (the organization's scope). Codes: policy-denied, memory-disabled (the organization turned memory off in its policy, or has no memory entitlement), memory-scope-forbidden (the caller may not act in the owner scope the request names, or does not own the memory)

  • 404

    No proposal with that id that the caller may decide on; or the plane has no memory database configured (MEMORY_DATABASE_URL), so the Memory M1 routes are off. Codes: memory-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.

  • 409

    The organization reached its capacity. Codes: memory-capacity-exceeded

  • 500

    Platform failure. Codes: internal-error

POST/memory/v1/proposals/{memory}/reject

Reject a proposal

Anmeldedaten
API-Key
Berechtigung
Eine vonmemory.usememory.reviewmemory.manage

Rejects a proposed memory. C6 has no rejected state, so the rejection erases the proposal: its text and vector are erased and the erasure is journaled in the deletion journal like any other, and the answer carries the journal receipt. A memory that is not a proposal the caller may decide on is 404 memory-not-found. No body.

curl
curl -X POST "https://api.eu.ccsio.ai/memory/v1/proposals/{memory}/reject" \
  -H "Authorization: Bearer $CCSIO_API_KEY"

Parameter

NameInBeschreibung
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.

memory
Pflicht
pathstring

The memory's id. A value outside the C6 identifier pattern, or one the caller may not read, is answered as a memory that does not exist.

Antworten

  • 200

    The receipt of the erasure of the proposal.

    Schema
    MemoryEraseReceipt
    • idstringPflicht

      A memory's id. It is the entry's C6 fact id, so it matches the C6 identifier pattern; core generates it as `m-` plus a lowercase ULID. Clients treat it as opaque.

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

    • statestringPflicht

      Erlaubte Werte: "erased"

    • event_idstringPflicht
    • journal_headobjectPflicht

      A {journalId, sequence, chainDigest} position in the deletion chain. Sequence zero is the explicit genesis, never an absent digest.

      • journal_idstringPflicht

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

      • sequenceintegerPflicht

        at least 0

      • chain_digeststringPflicht

        pattern ^sha256:[0-9a-f]{64}$

  • 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 `memory.use` (own scopes), `memory.review` (a team they review) or `memory.manage` (the organization's scope). Codes: policy-denied, memory-scope-forbidden (the caller may not act in the owner scope the request names, or does not own the memory)

  • 404

    No proposal with that id that the caller may decide on; or the plane has no memory database configured (MEMORY_DATABASE_URL), so the Memory M1 routes are off. Codes: memory-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

Erzeugt aus den Plattformverträgen beim Commit 5954fbc1.

Plattform entdecken

Deinen ersten API-Key holen

Die Registrierung ist offen. Vier Schritte bis zum ersten Aufruf: Konto erstellen, Organisation anlegen, API-Key erzeugen, loslegen.

  1. 01Konto erstellen
  2. 02Organisation anlegen
  3. 03API-Key erzeugen
  4. 04Loslegen