Skip to navigation
SDK ReferencegraphHyperedge

List hyperedges

Returns the graph’s hyperedges. A hyperedge is listed while it has at least one member edge. Supported filters are node_uuids, edge_uuids and episode_uuids: a hyperedge matches a list when any of its members does, and must match every list supplied.

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

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

OK
itemslist of objectsOptional
next_cursorstringOptional

Errors

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