Sign in

v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-024655133.4 KB
peers

Get Representation

Get a curated subset of a Peer's Representation. A Representation is always a subset of the total knowledge about the Peer. The subset can be scoped and filtered in various ways.

If a session_id is provided in the body, we get the Representation of the Peer scoped to that Session. If a target is provided, we get the Representation of the target from the perspective of the Peer. If no target is provided, we get the omniscient Honcho Representation of the Peer.

post/v3/workspaces/{workspace_id}/peers/{peer_id}/representation

Path parameters

workspace_idstring required
peer_idstring required

Request body

session_idstring nullable

Optional session ID within which to scope the representation

targetstring nullable

Optional peer ID to get the representation for, from the perspective of this peer

search_querystring nullable

Optional input to curate the representation around semantic search results

search_top_kinteger nullable

Only used if search_query is provided. Number of semantic-search-retrieved conclusions to include in the representation

search_max_distancenumber nullable

Only used if search_query is provided. Maximum distance to search for semantically relevant conclusions

include_most_frequentboolean nullable

Only used if search_query is provided. Whether to include the most frequent conclusions in the representation

max_conclusionsinteger nullable

Only used if search_query is provided. Maximum number of conclusions to include in the representation

Response

Successful Response

representationstring required