Caura / docs
API Reference

Memories · Get, update and delete

GET, PATCH and DELETE /api/v1/memories/{memory_id} — operate on one memory.

GET
/api/v1/memories/{memory_id}

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Path Parameters

memory_id*Memory Id
Formatuuid

Query Parameters

tenant_id*Tenant Id

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/memories/497f6eca-6276-4993-bfeb-53cbbbba6f08?tenant_id=string"
{
  "id": "string",
  "tenant_id": "string",
  "fleet_id": "string",
  "agent_id": "string",
  "agent_display_name": "string",
  "memory_type": "string",
  "title": "string",
  "content": "string",
  "weight": 0,
  "source_uri": "string",
  "run_id": "string",
  "metadata": {},
  "system_metadata": {},
  "content_hash": "string",
  "created_at": "string",
  "expires_at": "string",
  "deleted_at": "string",
  "subject_entity_id": "string",
  "predicate": "string",
  "object_value": "string",
  "ts_valid_start": "string",
  "ts_valid_end": "string",
  "status": "string",
  "visibility": "string",
  "recall_count": 0,
  "last_recalled_at": "string",
  "supersedes_id": "string",
  "entity_links": [],
  "embedding_preview": [
    0
  ],
  "embedding_stats": {}
}
{
  "detail": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
{
  "detail": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
PATCH
/api/v1/memories/{memory_id}

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Path Parameters

memory_id*Memory Id
Formatuuid

Query Parameters

tenant_id*Tenant Id
agent_id?string|null
metadata_mode?|

C7: alias for the body field of the same name. Body wins on conflict. When supplied as a query param without a matching metadata field in the body, returns 422 (same contract as the body-side validator). Provided so SDK callers that thread the toggle through a URL query don't silently get the default merge behaviour.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://loading/api/v1/memories/497f6eca-6276-4993-bfeb-53cbbbba6f08?tenant_id=string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenant_id": "string",
  "fleet_id": "string",
  "agent_id": "string",
  "agent_display_name": "string",
  "memory_type": "string",
  "title": "string",
  "content": "string",
  "weight": 0,
  "source_uri": "string",
  "run_id": "string",
  "metadata": {},
  "system_metadata": {},
  "created_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "entity_links": [],
  "similarity": 0,
  "score": 0,
  "score_parts": {
    "vec_sim": 0,
    "fts_score": 0,
    "freshness": 0,
    "entity_boost": 0,
    "recall_boost": 0,
    "temporal_boost": 0,
    "status_penalty": 0
  },
  "injected": false,
  "subject_entity_id": "2f43e1a1-7cec-4ccf-9421-4ab19090ca45",
  "predicate": "string",
  "object_value": "string",
  "ts_valid_start": "2019-08-24T14:15:22Z",
  "ts_valid_end": "2019-08-24T14:15:22Z",
  "status": "active",
  "visibility": "scope_team",
  "recall_count": 0,
  "last_recalled_at": "2019-08-24T14:15:22Z",
  "supersedes_id": "8149cd94-4e90-4a99-91f5-a3e0f9b829dc",
  "superseded_by": [
    {
      "old_memory_id": "07606bd2-b9bc-468a-8200-790e8b7345cf",
      "old_status": "string",
      "reason": "string",
      "old_content_preview": "string",
      "direction": "canonical"
    }
  ],
  "confidence": 0,
  "is_inferred": false,
  "scope": {},
  "usage": {
    "memories_stored": 0,
    "memories_limit": 0,
    "writes_remaining": 0
  }
}
{
  "detail": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
{
  "detail": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
DELETE
/api/v1/memories/{memory_id}

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Path Parameters

memory_id*Memory Id
Formatuuid

Query Parameters

tenant_id*Tenant Id
agent_id?string|null

Response Body

application/json

application/json

application/json

curl -X DELETE "https://loading/api/v1/memories/497f6eca-6276-4993-bfeb-53cbbbba6f08?tenant_id=string"
Empty
{
  "detail": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
{
  "detail": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}