Skip to main content
POST
/
v1
/
v2
/
conversations
Get or create a v2 conversation
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/v2/conversations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "chat",
  "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",
  "channel_subtype": "<string>",
  "session_type": "live",
  "external_id": "<string>",
  "org_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject": "<string>",
  "metadata": {},
  "tool_input_overrides": {},
  "context_variables": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "<string>",
  "status": "<string>",
  "session_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "channel_subtype": "<string>",
  "origin": "<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",
  "external_id": "<string>",
  "subject": "<string>",
  "tool_input_overrides": {}
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Get-or-create a v2 conversation (Phase F2).

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.

​
end_user_id
string<uuid>
required
​
channel
string
default:chat
​
assistant_id
string<uuid> | null
​
assistant_revision_id
string<uuid> | null
​
team_id
string<uuid> | null
​
team_revision_id
string<uuid> | null
​
channel_subtype
string | null
​
origin
enum<string> | null
Available options:
inbound,
outbound
​
session_type
enum<string>
default:live
Available options:
live,
test,
simulation
​
external_id
string | null
​
org_phone_number_id
string<uuid> | null
​
subject
string | null
​
metadata
Metadata · object
​
tool_input_overrides
Tool Input Overrides · object
​
context_variables
Context Variables · object

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
end_user_id
string<uuid>
required
​
channel
string
required
​
status
string
required
​
session_type
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
channel_subtype
string | null
​
origin
string | null
​
assistant_id
string<uuid> | null
​
assistant_revision_id
string<uuid> | null
​
team_id
string<uuid> | null
​
team_revision_id
string<uuid> | null
​
external_id
string | null
​
subject
string | null
​
tool_input_overrides
Tool Input Overrides · object