Skip to main content
POST
/
api
/
v1
/
agent-test
/
sessions
/
start
Start chat test session
curl --request POST \
  --url https://prod.featherhq.com/api/v1/agent-test/sessions/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "variables": {}
}
'
{
  "callId": "<string>",
  "roomName": "<string>",
  "livekitUrl": "<string>",
  "accessToken": "<string>",
  "agentVersion": {
    "id": "<string>",
    "version": 123,
    "name": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.featherhq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

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

Response

Test session created successfully

​
callId
string
required
​
roomName
string
required
​
livekitUrl
string
required
​
accessToken
string
required
​
agentVersion
object
required