Skip to main content
POST
Create a new transcription request

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

multipart/form-data
voice_file
file | null

Audio file to transcribe (max 128MB)

voice_url
string<uri> | null

URL to audio file

Example:

"https://example.com/audio.mp3"

possible_language
string | null

Expected language of the audio

Maximum string length: 10
Example:

"en"

possible_conversation
string | null

Context about the conversation

Example:

"Customer support call"

reference_id
string | null

External reference ID

Maximum string length: 255
Example:

"CALL-12345"

customer_voice_url
string<uri> | null

Customer's voice URL for reference

email
string<email> | null

Human agent email. If this email matches a real user in our system, we will link the transcription to that user account.

Maximum string length: 255
Example:

"agent@example.com"

customer_phone
string | null

Customer's phone number. The system will first check if a contact with this phone number exists and automatically assign that contact to the transcription. If no contact found by phone, it will check customer_email.

Maximum string length: 255
Example:

"+1234567890"

customer_email
string<email> | null

Customer's email address. The system will check if a contact with this email exists (if not found by phone first) and automatically assign that contact to the transcription.

Maximum string length: 255
Example:

"customer@example.com"

webhook_url
string<uri> | null

Webhook URL to receive completion notification. When transcription is completed, we will POST the results to this URL.

Example:

"https://example.com/webhook"

webhook_header_token
string | null

Token to be sent as 'Bearer {token}' in Authorization header when calling your webhook

Example:

"token123"

qa_agent_uuid
string<uuid> | null

UUID of the QA agent template to use. If omitted, the system will fall back to default selection.

Example:

"153580ac-af27-4c77-aa59-02e9f9b8fe1a"

coaching_agent_uuid
string<uuid> | null

UUID of the coaching agent template to use. If omitted, the system will fall back to default selection.

Example:

"6d4adde3-8fb0-4893-87e1-83f950723f4e"

Response

Created

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Transcription request submitted successfully"

data
object