List document episodes

GET

https://api.getzep.com/api/v4/graphs/:graph_uuid/documents/:document_id/episodes

GET

/api/v4/graphs/:graph_uuid/documents/:document_id/episodes

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.episode.list_for_document(
    graph_uuid="graph_uuid",
    document_id="document_id",
)

{
  "items": [
    {
      "content": "string",
      "content_policy": {
        "category_keys": [
          "health"
        ],
        "dropped_count": 0,
        "retained_count": 7,
        "revision": 3,
        "status": "complete",
        "violated": false
      },
      "created_at": "string",
      "document_id": "string",
      "graph_uuid": "string",
      "metadata": {},
      "processed": true,
      "reference_time": "string",
      "relevance": 1.1,
      "role": "system",
      "role_name": "string",
      "score": 1.1,
      "source": "text",
      "source_description": "string",
      "thread_uuid": "string",
      "user_uuid": "string",
      "uuid": "string"
    }
  ],
  "next_cursor": "string",
  "total_size": 1
}

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Path parameters

graph_uuidstringRequired

The UUID of the graph. For a user graph, you can also use the UUID of the user.

document_idstringRequired

Document ID

Query parameters

page_sizeintegerOptional1-100Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional

Opaque page cursor

Response

itemslist of objectsOptional

The episodes on this page.

next_cursorstringOptional

Opaque cursor for retrieving the next page, present only when more results are available.

total_sizeintegerOptional

Omitted for this collection; use next_cursor to detect the end of pagination.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error