v1

latestOpenAPI 3.1.0GNU Affero General Public License v3.0raw.githubusercontent.com2026-05-074555150.3 KB
peers

Get Peer Context

Get context for a peer, including their representation and peer card.

This endpoint returns a curated subset of the representation and peer card for a peer. If a target is specified, returns the context for the target from the observer peer's perspective. If no target is specified, returns the peer's own context (self-observation).

This is useful for getting all the context needed about a peer without making multiple API calls.

get/v3/workspaces/{workspace_id}/peers/{peer_id}/context

Path parameters

workspace_idstring required
peer_idstring required

ID of the observer peer

ID of the observer peer

Query parameters

targetstring nullable

Optional target peer to get context for, from the observer's perspective. If not provided, returns the observer's own context (self-observation)

Optional target peer to get context for, from the observer's perspective. If not provided, returns the observer's own context (self-observation)

search_querystring nullable

Optional query to curate the representation around semantic search results

Optional query 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

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

search_max_distancenumber nullable

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

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

include_most_frequentboolean

Whether to include the most frequent conclusions in the representation

Whether to include the most frequent conclusions in the representation

max_conclusionsinteger nullable

Maximum number of conclusions to include in the representation

Maximum number of conclusions to include in the representation

Response

Successful Response

peer_idstring required

The ID of the peer

target_idstring required

The ID of the target peer being observed

representationstring nullable

A curated subset of the representation of the target peer from the observer's perspective

peer_cardstring[] nullable

The peer card for the target peer from the observer's perspective