Skip to main content
POST
/
analyze
/
live
/
start
Start live session
curl --request POST \
  --url https://api.illocution.ai/analyze/live/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "goal": "<string>",
  "filename": "call.wav",
  "suffix": ".wav",
  "ttl_seconds": 900
}
'
{
  "session_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "next_chunk_seq": 123
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Can also be passed as query parameter: api_key=

Body

application/json
​
goal
string

Optional analysis focus

​
filename
string

Filename for the session

Example:

"call.wav"

​
suffix
string

File extension

Example:

".wav"

​
ttl_seconds
integer
default:900

Time to live in seconds (default: 900)

Response

Live session created

​
session_id
string
​
expires_at
string<date-time>
​
status
string
​
next_chunk_seq
integer

Next expected chunk sequence number (zero-based)