Get or create a v2 conversation
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/conversations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_external_end_user_id": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_type": "live",
"external_id": "<string>",
"subject": "<string>",
"metadata": {},
"tool_input_overrides": {},
"context_variables": {},
"test_features": {
"identity_resolution": false,
"memory": false,
"summarization": false,
"extraction": false,
"evaluations": false,
"knowledge_gap_analysis": false
}
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/conversations"
payload = {
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_external_end_user_id": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_type": "live",
"external_id": "<string>",
"subject": "<string>",
"metadata": {},
"tool_input_overrides": {},
"context_variables": {},
"test_features": {
"identity_resolution": False,
"memory": False,
"summarization": False,
"extraction": False,
"evaluations": False,
"knowledge_gap_analysis": False
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
org_external_end_user_id: '<string>',
assistant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assistant_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
team_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
session_type: 'live',
external_id: '<string>',
subject: '<string>',
metadata: {},
tool_input_overrides: {},
context_variables: {},
test_features: {
identity_resolution: false,
memory: false,
summarization: false,
extraction: false,
evaluations: false,
knowledge_gap_analysis: false
}
})
};
fetch('https://api-sandbox.featherhq.com/v1/conversations', 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-sandbox.featherhq.com/v1/conversations",
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([
'end_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'org_external_end_user_id' => '<string>',
'assistant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assistant_revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'team_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'team_revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'session_type' => 'live',
'external_id' => '<string>',
'subject' => '<string>',
'metadata' => [
],
'tool_input_overrides' => [
],
'context_variables' => [
],
'test_features' => [
'identity_resolution' => false,
'memory' => false,
'summarization' => false,
'extraction' => false,
'evaluations' => false,
'knowledge_gap_analysis' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/conversations"
payload := strings.NewReader("{\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_external_end_user_id\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistant_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_type\": \"live\",\n \"external_id\": \"<string>\",\n \"subject\": \"<string>\",\n \"metadata\": {},\n \"tool_input_overrides\": {},\n \"context_variables\": {},\n \"test_features\": {\n \"identity_resolution\": false,\n \"memory\": false,\n \"summarization\": false,\n \"extraction\": false,\n \"evaluations\": false,\n \"knowledge_gap_analysis\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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-sandbox.featherhq.com/v1/conversations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_external_end_user_id\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistant_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_type\": \"live\",\n \"external_id\": \"<string>\",\n \"subject\": \"<string>\",\n \"metadata\": {},\n \"tool_input_overrides\": {},\n \"context_variables\": {},\n \"test_features\": {\n \"identity_resolution\": false,\n \"memory\": false,\n \"summarization\": false,\n \"extraction\": false,\n \"evaluations\": false,\n \"knowledge_gap_analysis\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_external_end_user_id\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistant_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_type\": \"live\",\n \"external_id\": \"<string>\",\n \"subject\": \"<string>\",\n \"metadata\": {},\n \"tool_input_overrides\": {},\n \"context_variables\": {},\n \"test_features\": {\n \"identity_resolution\": false,\n \"memory\": false,\n \"summarization\": false,\n \"extraction\": false,\n \"evaluations\": false,\n \"knowledge_gap_analysis\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "<string>",
"surface": "<string>",
"status": "<string>",
"session_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"subject": "<string>",
"tool_input_overrides": {},
"test_features": {
"identity_resolution": true,
"memory": true,
"summarization": true,
"extraction": true,
"evaluations": true,
"knowledge_gap_analysis": true,
"version": 1
}
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
Get-or-create a v2 conversation (Phase F2) — CHAT ONLY (D4/ADR-007).
The generic create route creates chat conversations only: sms / voice /
email creation stays adapter-owned (/v1/sms/send, voice dispatch, the
email pipeline). channel is therefore not a request field (forced
server-side), and origin / channel_subtype are gone — both are
server-assigned (ADR-005 / ADR-004).
Bind to exactly one of a single Assistant (assistant_id) or a Team
(team_id + team_revision_id) — the single_xor_team CHECK on
conversations. assistant_revision_id is optional; when omitted it
is resolved from the agent's active revision and pinned at bind time.
1 - 255live, test, simulation Show child attributes
Show child attributes
Caller-supplied toggles. Unknown fields are rejected.
Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
Resolved, immutable snapshot persisted on a test conversation.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/conversations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_external_end_user_id": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_type": "live",
"external_id": "<string>",
"subject": "<string>",
"metadata": {},
"tool_input_overrides": {},
"context_variables": {},
"test_features": {
"identity_resolution": false,
"memory": false,
"summarization": false,
"extraction": false,
"evaluations": false,
"knowledge_gap_analysis": false
}
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/conversations"
payload = {
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_external_end_user_id": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_type": "live",
"external_id": "<string>",
"subject": "<string>",
"metadata": {},
"tool_input_overrides": {},
"context_variables": {},
"test_features": {
"identity_resolution": False,
"memory": False,
"summarization": False,
"extraction": False,
"evaluations": False,
"knowledge_gap_analysis": False
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
org_external_end_user_id: '<string>',
assistant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assistant_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
team_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
session_type: 'live',
external_id: '<string>',
subject: '<string>',
metadata: {},
tool_input_overrides: {},
context_variables: {},
test_features: {
identity_resolution: false,
memory: false,
summarization: false,
extraction: false,
evaluations: false,
knowledge_gap_analysis: false
}
})
};
fetch('https://api-sandbox.featherhq.com/v1/conversations', 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-sandbox.featherhq.com/v1/conversations",
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([
'end_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'org_external_end_user_id' => '<string>',
'assistant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assistant_revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'team_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'team_revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'session_type' => 'live',
'external_id' => '<string>',
'subject' => '<string>',
'metadata' => [
],
'tool_input_overrides' => [
],
'context_variables' => [
],
'test_features' => [
'identity_resolution' => false,
'memory' => false,
'summarization' => false,
'extraction' => false,
'evaluations' => false,
'knowledge_gap_analysis' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/conversations"
payload := strings.NewReader("{\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_external_end_user_id\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistant_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_type\": \"live\",\n \"external_id\": \"<string>\",\n \"subject\": \"<string>\",\n \"metadata\": {},\n \"tool_input_overrides\": {},\n \"context_variables\": {},\n \"test_features\": {\n \"identity_resolution\": false,\n \"memory\": false,\n \"summarization\": false,\n \"extraction\": false,\n \"evaluations\": false,\n \"knowledge_gap_analysis\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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-sandbox.featherhq.com/v1/conversations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_external_end_user_id\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistant_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_type\": \"live\",\n \"external_id\": \"<string>\",\n \"subject\": \"<string>\",\n \"metadata\": {},\n \"tool_input_overrides\": {},\n \"context_variables\": {},\n \"test_features\": {\n \"identity_resolution\": false,\n \"memory\": false,\n \"summarization\": false,\n \"extraction\": false,\n \"evaluations\": false,\n \"knowledge_gap_analysis\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_external_end_user_id\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistant_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"team_revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_type\": \"live\",\n \"external_id\": \"<string>\",\n \"subject\": \"<string>\",\n \"metadata\": {},\n \"tool_input_overrides\": {},\n \"context_variables\": {},\n \"test_features\": {\n \"identity_resolution\": false,\n \"memory\": false,\n \"summarization\": false,\n \"extraction\": false,\n \"evaluations\": false,\n \"knowledge_gap_analysis\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "<string>",
"surface": "<string>",
"status": "<string>",
"session_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"subject": "<string>",
"tool_input_overrides": {},
"test_features": {
"identity_resolution": true,
"memory": true,
"summarization": true,
"extraction": true,
"evaluations": true,
"knowledge_gap_analysis": true,
"version": 1
}
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}