Get Or Create Session
curl --request POST \
--url https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"metadata": {},
"peers": {},
"configuration": {
"custom_instructions": "<string>",
"reasoning": {
"enabled": true,
"custom_instructions": "<string>"
},
"peer_card": {
"use": true,
"create": true,
"custom_instructions": "<string>"
},
"summary": {
"enabled": true,
"messages_per_short_summary": 11,
"messages_per_long_summary": 21,
"custom_instructions": "<string>"
},
"dream": {
"enabled": true,
"custom_instructions": "<string>"
},
"dialectic": {
"custom_instructions": "<string>"
}
},
"scopes": [
"<string>"
]
}
'import requests
url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions"
payload = {
"id": "<string>",
"metadata": {},
"peers": {},
"configuration": {
"custom_instructions": "<string>",
"reasoning": {
"enabled": True,
"custom_instructions": "<string>"
},
"peer_card": {
"use": True,
"create": True,
"custom_instructions": "<string>"
},
"summary": {
"enabled": True,
"messages_per_short_summary": 11,
"messages_per_long_summary": 21,
"custom_instructions": "<string>"
},
"dream": {
"enabled": True,
"custom_instructions": "<string>"
},
"dialectic": { "custom_instructions": "<string>" }
},
"scopes": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
metadata: {},
peers: {},
configuration: {
custom_instructions: '<string>',
reasoning: {enabled: true, custom_instructions: '<string>'},
peer_card: {use: true, create: true, custom_instructions: '<string>'},
summary: {
enabled: true,
messages_per_short_summary: 11,
messages_per_long_summary: 21,
custom_instructions: '<string>'
},
dream: {enabled: true, custom_instructions: '<string>'},
dialectic: {custom_instructions: '<string>'}
},
scopes: ['<string>']
})
};
fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'metadata' => [
],
'peers' => [
],
'configuration' => [
'custom_instructions' => '<string>',
'reasoning' => [
'enabled' => true,
'custom_instructions' => '<string>'
],
'peer_card' => [
'use' => true,
'create' => true,
'custom_instructions' => '<string>'
],
'summary' => [
'enabled' => true,
'messages_per_short_summary' => 11,
'messages_per_long_summary' => 21,
'custom_instructions' => '<string>'
],
'dream' => [
'enabled' => true,
'custom_instructions' => '<string>'
],
'dialectic' => [
'custom_instructions' => '<string>'
]
],
'scopes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"metadata\": {},\n \"peers\": {},\n \"configuration\": {\n \"custom_instructions\": \"<string>\",\n \"reasoning\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"peer_card\": {\n \"use\": true,\n \"create\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"summary\": {\n \"enabled\": true,\n \"messages_per_short_summary\": 11,\n \"messages_per_long_summary\": 21,\n \"custom_instructions\": \"<string>\"\n },\n \"dream\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"dialectic\": {\n \"custom_instructions\": \"<string>\"\n }\n },\n \"scopes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"metadata\": {},\n \"peers\": {},\n \"configuration\": {\n \"custom_instructions\": \"<string>\",\n \"reasoning\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"peer_card\": {\n \"use\": true,\n \"create\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"summary\": {\n \"enabled\": true,\n \"messages_per_short_summary\": 11,\n \"messages_per_long_summary\": 21,\n \"custom_instructions\": \"<string>\"\n },\n \"dream\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"dialectic\": {\n \"custom_instructions\": \"<string>\"\n }\n },\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"metadata\": {},\n \"peers\": {},\n \"configuration\": {\n \"custom_instructions\": \"<string>\",\n \"reasoning\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"peer_card\": {\n \"use\": true,\n \"create\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"summary\": {\n \"enabled\": true,\n \"messages_per_short_summary\": 11,\n \"messages_per_long_summary\": 21,\n \"custom_instructions\": \"<string>\"\n },\n \"dream\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"dialectic\": {\n \"custom_instructions\": \"<string>\"\n }\n },\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"uid": "<string>",
"is_active": true,
"workspace_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"metadata": {},
"configuration": {},
"scopes": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}sessions
Get Or Create Session
Get a Session by ID or create a new Session with the given ID.
If Session ID is provided as a parameter, it verifies the Session is in the Workspace. Otherwise, it uses the session_id from the JWT for verification.
POST
/
v3
/
workspaces
/
{workspace_id}
/
sessions
Get Or Create Session
curl --request POST \
--url https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"metadata": {},
"peers": {},
"configuration": {
"custom_instructions": "<string>",
"reasoning": {
"enabled": true,
"custom_instructions": "<string>"
},
"peer_card": {
"use": true,
"create": true,
"custom_instructions": "<string>"
},
"summary": {
"enabled": true,
"messages_per_short_summary": 11,
"messages_per_long_summary": 21,
"custom_instructions": "<string>"
},
"dream": {
"enabled": true,
"custom_instructions": "<string>"
},
"dialectic": {
"custom_instructions": "<string>"
}
},
"scopes": [
"<string>"
]
}
'import requests
url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions"
payload = {
"id": "<string>",
"metadata": {},
"peers": {},
"configuration": {
"custom_instructions": "<string>",
"reasoning": {
"enabled": True,
"custom_instructions": "<string>"
},
"peer_card": {
"use": True,
"create": True,
"custom_instructions": "<string>"
},
"summary": {
"enabled": True,
"messages_per_short_summary": 11,
"messages_per_long_summary": 21,
"custom_instructions": "<string>"
},
"dream": {
"enabled": True,
"custom_instructions": "<string>"
},
"dialectic": { "custom_instructions": "<string>" }
},
"scopes": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
metadata: {},
peers: {},
configuration: {
custom_instructions: '<string>',
reasoning: {enabled: true, custom_instructions: '<string>'},
peer_card: {use: true, create: true, custom_instructions: '<string>'},
summary: {
enabled: true,
messages_per_short_summary: 11,
messages_per_long_summary: 21,
custom_instructions: '<string>'
},
dream: {enabled: true, custom_instructions: '<string>'},
dialectic: {custom_instructions: '<string>'}
},
scopes: ['<string>']
})
};
fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'metadata' => [
],
'peers' => [
],
'configuration' => [
'custom_instructions' => '<string>',
'reasoning' => [
'enabled' => true,
'custom_instructions' => '<string>'
],
'peer_card' => [
'use' => true,
'create' => true,
'custom_instructions' => '<string>'
],
'summary' => [
'enabled' => true,
'messages_per_short_summary' => 11,
'messages_per_long_summary' => 21,
'custom_instructions' => '<string>'
],
'dream' => [
'enabled' => true,
'custom_instructions' => '<string>'
],
'dialectic' => [
'custom_instructions' => '<string>'
]
],
'scopes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"metadata\": {},\n \"peers\": {},\n \"configuration\": {\n \"custom_instructions\": \"<string>\",\n \"reasoning\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"peer_card\": {\n \"use\": true,\n \"create\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"summary\": {\n \"enabled\": true,\n \"messages_per_short_summary\": 11,\n \"messages_per_long_summary\": 21,\n \"custom_instructions\": \"<string>\"\n },\n \"dream\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"dialectic\": {\n \"custom_instructions\": \"<string>\"\n }\n },\n \"scopes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"metadata\": {},\n \"peers\": {},\n \"configuration\": {\n \"custom_instructions\": \"<string>\",\n \"reasoning\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"peer_card\": {\n \"use\": true,\n \"create\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"summary\": {\n \"enabled\": true,\n \"messages_per_short_summary\": 11,\n \"messages_per_long_summary\": 21,\n \"custom_instructions\": \"<string>\"\n },\n \"dream\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"dialectic\": {\n \"custom_instructions\": \"<string>\"\n }\n },\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"metadata\": {},\n \"peers\": {},\n \"configuration\": {\n \"custom_instructions\": \"<string>\",\n \"reasoning\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"peer_card\": {\n \"use\": true,\n \"create\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"summary\": {\n \"enabled\": true,\n \"messages_per_short_summary\": 11,\n \"messages_per_long_summary\": 21,\n \"custom_instructions\": \"<string>\"\n },\n \"dream\": {\n \"enabled\": true,\n \"custom_instructions\": \"<string>\"\n },\n \"dialectic\": {\n \"custom_instructions\": \"<string>\"\n }\n },\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"uid": "<string>",
"is_active": true,
"workspace_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"metadata": {},
"configuration": {},
"scopes": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Session creation parameters
Required string length:
1 - 512Pattern:
^[a-zA-Z0-9_-]+$Show child attributes
Show child attributes
The set of options that can be in a session DB-level configuration dictionary.
All fields are optional. Session-level configuration overrides workspace-level configuration, which overrides global configuration.
Show child attributes
Show child attributes
Optional list of (unprefixed) scope names to add this session to. Each scope is created if it does not exist yet. If the session already has messages, its existing documents are backfilled into the scope asynchronously.
Maximum array length:
100Response
Successful Response
Immutable identifier Honcho assigns to this session. id is the name the client chose; uid is generated by the server.
Names of the scopes this session is an active member of. Only returned by the session list when include_scopes is true.
Was this page helpful?