Skip to navigation
SDK ReferenceGraphEpisode

List episodes

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
The UUID of the graph. For a user graph, you can also use the UUID of the user.

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
order_byenumOptional
Sort field
Allowed values:
orderenumOptional

Sort direction: asc or desc

Allowed values:

Request

Request body
filtersobjectOptional
Filters that limit the episodes in the list.

Response

OK
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