Skip to navigation

Get episode

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.
episode_uuidstringRequired
Episode UUID

Response

OK
contentstringOptional
The raw content of the episode.
content_policyobjectOptional
The content policy state of the episode, present only on a graph with a bound content policy rule.
created_atstringOptional
The time Zep received the episode.
document_idstringOptional

The developer-assigned identifier of the document this episode belongs to, present only for episodes added to a document.

graph_uuidstringOptional
The unique identifier of the graph this episode belongs to.
metadatamap from strings to anyOptional
Custom metadata associated with the episode.
processedbooleanOptional
Whether the episode has finished graph extraction and indexing.
reference_timestringOptional

The episode’s reference time, used for temporal reasoning: the time that the developer supplied on add, or the ingestion time when the developer supplied no time.

relevancedoubleOptional

A cross-encoder-derived relevance score, present only when the cross-encoder reranker scored this result; like score, it is omitted from plain list results.

roleenumOptional
The role of the episode's sender, present only when the episode was added as a message.
Allowed values:
role_namestringOptional

The free-form display name of the episode’s sender, present only when the episode was added as a message.

scoredoubleOptional

The ranking score returned with every search result; omitted when the episode appears in a plain list rather than a search result.

sourceenumOptional

The format of the episode’s content: text, json, or message.

Allowed values:
source_descriptionstringOptional

A free-form description of where the episode’s content came from.

thread_uuidstringOptional
The thread this episode belongs to, present only for episodes added to a thread.
user_uuidstringOptional
The unique identifier of the user that owns the graph. Present only when the graph is a user graph.
uuidstringOptional
The unique identifier of the episode.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error