Skip to navigation

List thread summaries

Lists the thread summaries of a graph and returns one page of results. The default page_size is 50, and the maximum page_size is 100. You can sort by uuid or created_at. The default sort is uuid in descending order. You cannot use these filters fields: node_labels, exclude_node_labels, edge_types, exclude_edge_types, edge_uuids, episode_uuids, connected_node_uuids, source_node_uuids, target_node_uuids, and content_policy_violated. date_filters supports only the created_at field. If the request has an unsupported or unknown filter field, the API returns an unsupported_filter error.

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 key: uuid (default) or created_at

Allowed values:
orderenumOptional

Sort direction: asc or desc (default desc)

Allowed values:

Request

Request body
filtersobjectOptional
Filters that limit the items in the list. The operation description names the filter fields that the operation does not support.

Response

OK
itemslist of objectsOptional
The thread summaries on this page.
next_cursorstringOptional

The cursor to pass as the next request’s cursor to fetch the following page; absent when no further pages remain.

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