v1

latestOpenAPI 3.0.02026-07-14235231.7 KB
conversation

Record a conversation

put/conversations/{conversation_id}/record

Request body

action'start' | 'stop' required

Recording Action

event_methodstring

The HTTP method used to send event information to event_url.

event_urlstring[]

The webhook endpoint where recording progress events are sent to.

format'mp3' | 'wav'

Record the Conversation in a specific format.

splitstring

Record the sent and received audio in separate channels of a stereo recording

Example request

{
  "action": "start",
  "event_method": "POST",
  "event_url": [
    "https://example.com/event"
  ],
  "format": "mp3",
  "split": "conversation"
}

Response

No Content