Documents

Get document details

Changed on

Get a specific document including its original text

get/v1/default/banks/{bank_id}/documents/{document_id}

Request

Path parameters

bank_idstring required
document_idstring required

Headers

authorizationstring nullable

Response

Successful Response

idstring required
bank_idstring required
original_textstring nullable required
content_hashstring nullable required
created_atstring required
updated_atstring required
memory_unit_countinteger required
nodes_by_fact_typeobject nullable

Memory count per fact type (world, experience, observation)

tagsstring[]

Tags associated with this document

document_metadataobject nullable

Document metadata

retain_paramsobject nullable

Parameters used during retain

Example response

{
  "bank_id": "user123",
  "content_hash": "abc123",
  "created_at": "2024-01-15T10:30:00Z",
  "document_metadata": {
    "channel": "#general",
    "source": "slack"
  },
  "id": "session_1",
  "memory_unit_count": 15,
  "original_text": "Full document text here...",
  "retain_params": {
    "context": "Team meeting notes",
    "event_date": "2024-01-15"
  },
  "tags": [
    "user_a",
    "session_123"
  ],
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

    • breaking

      response property original_text list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status