Skip to main content
POST
/
v1
/
api
/
conversations
Create a conversation
curl --request POST \
  --url https://api.hq.zone/v1/api/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "adapter_conv_id": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel_kind": "<string>",
  "channel_thread": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json
​
agent_id
string<uuid>
required

The agent the user picked in the modal. Tenant-scoped: we refuse to create against an agent_id that doesn't live in the caller's workspace.

Response

New web conversation created

​
adapter_conv_id
string
required
​
agent_id
string<uuid>
required
​
channel_kind
string
required
​
channel_thread
string
required
​
id
string<uuid>
required