Add episode

POST

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

POST

/api/v4/graphs/:graph_uuid/episodes

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

{
  "episode": {
    "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"
  },
  "task": {
    "completed_at": "string",
    "created_at": "string",
    "error": {
      "code": "string",
      "details": {},
      "message": "string",
      "param": "string",
      "request_id": "string"
    },
    "progress": {
      "stage": "string"
    },
    "result": {},
    "started_at": "string",
    "status": "string",
    "type": "string",
    "updated_at": "string",
    "uuid": "string"
  }
}

Authentication

AuthorizationApi-Key

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

Path parameters

graph_uuidstringRequired

Graph UUID

Request

Request body

datastringRequired

The episode content to add to the graph.

created_atstringOptional

The episode's reference time, used for temporal reasoning rather than ingestion time.

document_idstringOptional<=100 characters

Groups this episode as a chunk of a document on the graph.

metadatamap from strings to anyOptional

Metadata to store on the episode. Max 10 keys. Values must be strings, numbers, booleans, or arrays of scalars.

source_descriptionstringOptional

A description of the source of this episode.

strict_ontologybooleanOptional

When true, prevents extraction of generic entity nodes that do not match the configured ontology.

typeenumOptional

The data format of the episode: text, json, or message. Defaults to text.

Allowed values:

Response

Accepted

episodeobjectOptional

The newly created episode, a full resource that is readable immediately. Its processed field is false until graph extraction finishes.

taskobjectOptional

The asynchronous task that tracks the episode's graph extraction and indexing.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error