Skip to main content
POST
/
api
/
v1
/
threads
/
web
Create a new web chat thread
curl --request POST \
  --url https://prod.featherhq.com/api/v1/threads/web \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "variables": {}
}
'
{
  "thread": {
    "id": "<string>",
    "organizationId": "<string>",
    "agentVersionId": "<string>",
    "toPhoneNumber": "<string>",
    "fromPhoneNumber": "<string>",
    "fromPhoneNumberId": "<string>",
    "leadId": "<string>",
    "isActive": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "closedAt": "<string>",
    "closedReason": "<string>",
    "agentId": "<string>",
    "agentDetails": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>"
    },
    "agentVersionDetails": {
      "id": "<string>",
      "version": 123,
      "name": "<string>",
      "smsMaxTokens": 123,
      "smsTemperature": 123,
      "discardInboundSms": true
    },
    "metadata": {},
    "variables": {}
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json
agentId
string<uuid>
required
metadata
object
variables
object

Response

Web chat thread created successfully

thread
object
required