List episodes

POST

https://api.getzep.com/api/v4/graphs/:graph_uuid/episodes/list

POST

/api/v4/graphs/:graph_uuid/episodes/list

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

{
  "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,
      "relevance": 1.1,
      "role": "system",
      "role_name": "string",
      "score": 1.1,
      "source": "text",
      "source_description": "string",
      "thread_uuid": "string",
      "uuid": "string",
      "valid_at": "string"
    }
  ],
  "next_cursor": "string",
  "total_size": 1
}

Lists the episodes of a graph. filters.mentioned_node_uuids restricts the results to episodes that mention any of the listed node UUIDs. The list can also contain episode UUIDs: an episode UUID matches that episode, so one request can return a known set of episodes. At most 256 entries. filters.metadata_filters restricts the results to episodes whose stored metadata matches the predicate.

Authentication

AuthorizationApi-Key

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

Path parameters

graph_uuidstringRequired

Graph UUID

Query parameters

limitintegerOptional

Page size

cursorstringOptional

Opaque page cursor

order_byenumOptional

Sort field

Allowed values:

orderenumOptional

Sort direction: asc or desc

Allowed values:

Request

Request body

filtersmap from strings to anyOptional

Filters constraining which items are returned.

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