Skip to main content
GET
Get Peer Context

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id
string
required
peer_id
string
required

ID of the observer peer

Query Parameters

target
string | null

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

search_query
string | null

Optional query to curate the representation around semantic search results

search_top_k
integer | null

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

Required range: 1 <= x <= 100
search_max_distance
number | null

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

Required range: 0 <= x <= 1
include_most_frequent
boolean
default:true

Whether to include the most frequent conclusions in the representation

max_conclusions
integer | null

Maximum number of conclusions to include in the representation

Required range: 1 <= x <= 100

Response

Successful Response

Context for a peer, including representation and peer card.

peer_id
string
required

The ID of the peer

target_id
string
required

The ID of the target peer being observed

representation
string | null

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

peer_card
string[] | null

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