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_uuid
The UUID of the graph. For a user graph, you can also use the UUID of the user.
Query parameters
page_size
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.
cursor
Opaque page cursor
order_by
Sort key: uuid or created_at
Allowed values:
order
Sort direction: asc or desc
Allowed values:
Request
Request body
filters
Filters that limit the hyperedges in the list.
Response
OK
items
next_cursor
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error