Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request POST \
--url http://localhost:3000/v2/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "<string>",
"connector_account_ids": [
"<string>"
],
"title": "<string>",
"targets": [
{
"id": "<string>",
"document": "<string>",
"name": "<string>",
"trade_name": "<string>",
"legal_name": "<string>"
}
],
"channel": "<string>"
}
'import requests
url = "http://localhost:3000/v2/sessions"
payload = {
"agent_id": "<string>",
"connector_account_ids": ["<string>"],
"title": "<string>",
"targets": [
{
"id": "<string>",
"document": "<string>",
"name": "<string>",
"trade_name": "<string>",
"legal_name": "<string>"
}
],
"channel": "<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({
agent_id: '<string>',
connector_account_ids: ['<string>'],
title: '<string>',
targets: [
{
id: '<string>',
document: '<string>',
name: '<string>',
trade_name: '<string>',
legal_name: '<string>'
}
],
channel: '<string>'
})
};
fetch('http://localhost:3000/v2/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/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([
'agent_id' => '<string>',
'connector_account_ids' => [
'<string>'
],
'title' => '<string>',
'targets' => [
[
'id' => '<string>',
'document' => '<string>',
'name' => '<string>',
'trade_name' => '<string>',
'legal_name' => '<string>'
]
],
'channel' => '<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 := "http://localhost:3000/v2/sessions"
payload := strings.NewReader("{\n \"agent_id\": \"<string>\",\n \"connector_account_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"targets\": [\n {\n \"id\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\"\n }\n ],\n \"channel\": \"<string>\"\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("http://localhost:3000/v2/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"<string>\",\n \"connector_account_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"targets\": [\n {\n \"id\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\"\n }\n ],\n \"channel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/sessions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"<string>\",\n \"connector_account_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"targets\": [\n {\n \"id\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\"\n }\n ],\n \"channel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodycurl --request POST \
--url http://localhost:3000/v2/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "<string>",
"connector_account_ids": [
"<string>"
],
"title": "<string>",
"targets": [
{
"id": "<string>",
"document": "<string>",
"name": "<string>",
"trade_name": "<string>",
"legal_name": "<string>"
}
],
"channel": "<string>"
}
'import requests
url = "http://localhost:3000/v2/sessions"
payload = {
"agent_id": "<string>",
"connector_account_ids": ["<string>"],
"title": "<string>",
"targets": [
{
"id": "<string>",
"document": "<string>",
"name": "<string>",
"trade_name": "<string>",
"legal_name": "<string>"
}
],
"channel": "<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({
agent_id: '<string>',
connector_account_ids: ['<string>'],
title: '<string>',
targets: [
{
id: '<string>',
document: '<string>',
name: '<string>',
trade_name: '<string>',
legal_name: '<string>'
}
],
channel: '<string>'
})
};
fetch('http://localhost:3000/v2/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/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([
'agent_id' => '<string>',
'connector_account_ids' => [
'<string>'
],
'title' => '<string>',
'targets' => [
[
'id' => '<string>',
'document' => '<string>',
'name' => '<string>',
'trade_name' => '<string>',
'legal_name' => '<string>'
]
],
'channel' => '<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 := "http://localhost:3000/v2/sessions"
payload := strings.NewReader("{\n \"agent_id\": \"<string>\",\n \"connector_account_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"targets\": [\n {\n \"id\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\"\n }\n ],\n \"channel\": \"<string>\"\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("http://localhost:3000/v2/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"<string>\",\n \"connector_account_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"targets\": [\n {\n \"id\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\"\n }\n ],\n \"channel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/sessions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"<string>\",\n \"connector_account_ids\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"targets\": [\n {\n \"id\": \"<string>\",\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\"\n }\n ],\n \"channel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyOAuth2 Authorization Code flow
Base39 agent id (agt_*). Defaults to the configured Base39 agent.
Human-readable session title.
Primary targets available to the backend when deriving the session title.
Show child attributes
Originating channel catalog key.