Get Peer Context

curl --request GET \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "peer_id": "<string>",
  "target_id": "<string>",
  "representation": {
    "explicit": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message_ids": [
          123
        ],
        "session_name": "<string>",
        "content": "<string>"
      }
    ],
    "deductive": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message_ids": [
          123
        ],
        "session_name": "<string>",
        "conclusion": "<string>",
        "premises": [
          "<string>"
        ]
      }
    ]
  },
  "peer_card": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

workspaces

{workspace_id}

peers

{peer_id}

context

Get Peer Context

curl --request GET \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/peers/{peer_id}/context")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "peer_id": "<string>",
  "target_id": "<string>",
  "representation": {
    "explicit": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message_ids": [
          123
        ],
        "session_name": "<string>",
        "content": "<string>"
      }
    ],
    "deductive": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message_ids": [
          123
        ],
        "session_name": "<string>",
        "conclusion": "<string>",
        "premises": [
          "<string>"
        ]
      }
    ]
  },
  "peer_card": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

ID of the workspace

peer_id

string

required

ID of the peer (observer)

Query Parameters

target

string | null

The target peer to get context for. If not provided, returns the peer'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 observations to include

Required range: 1 <= x <= 100

search_max_distance

number | null

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

Required range: 0 <= x <= 1

include_most_derived

boolean

default:true

Whether to include the most derived observations in the representation

max_observations

integer | null

Maximum number of observations 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

Representation · object | null

The working representation of the target peer from the observer's perspective

Show child attributes

peer_card

string[] | null

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

API Documentation

workspaces

peers

sessions

messages

observations

webhooks

miscellaneous

Get Peer Context

Authorizations

Path Parameters

Query Parameters

Response