Update Session

curl --request PUT \
  --url https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "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>"
    }
  }
}
'

import requests

url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}"

payload = {
    "metadata": {},
    "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>" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {},
    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>'}
    }
  })
};

fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}', 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/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        
    ],
    '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>'
        ]
    ]
  ]),
  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/{session_id}"

	payload := strings.NewReader("{\n  \"metadata\": {},\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}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {},\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {},\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}"

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": {}
    }
  ]
}

PUT

workspaces

{workspace_id}

sessions

{session_id}

Update Session

curl --request PUT \
  --url https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "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>"
    }
  }
}
'

import requests

url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}"

payload = {
    "metadata": {},
    "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>" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {},
    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>'}
    }
  })
};

fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}', 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/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        
    ],
    '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>'
        ]
    ]
  ]),
  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/{session_id}"

	payload := strings.NewReader("{\n  \"metadata\": {},\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}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {},\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/sessions/{session_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {},\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}"

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

Authorization

string

header

required

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

Path Parameters

workspace_id

string

required

session_id

string

required

Body

application/json

Updated session parameters

metadata

Metadata · object | null

configuration

SessionConfiguration · object | null

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

Response

Successful Response

string

required

uid

string

required

Immutable identifier Honcho assigns to this session. id is the name the client chose; uid is generated by the server.

is_active

boolean

required

workspace_id

string

required

created_at

string<date-time>

required

metadata

Metadata · object

configuration

Configuration · object

scopes

string[] | null

Names of the scopes this session is an active member of. Only returned by the session list when include_scopes is true.

API Documentation

workspaces

dreams

peers

sessions

scopes

messages

conclusions

webhooks

miscellaneous

Update Session

Authorizations

Path Parameters

Body

Response