Skip to main content
POST
Create an async transcription job

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Headers

Idempotency-Key
string

Opt-in safe retry (JSON body path). Reusing the key with an identical body replays the original 202 response; reusing it with a different body returns 409.

Maximum string length: 255

Body

audio_url
string<uri>
required

https URL of the audio to transcribe.

model
string
default:pyai-hear-telephony
channel
boolean
default:false

Dual-channel (stereo) diarization: transcribe each channel separately and label speakers per channel (exact).

diarize
boolean
default:false

Single-track (mono) speaker diarization via Sortformer; words are aligned to speaker turns. Use channel instead for stereo recordings.

numerals
boolean
default:false

Format spoken numbers as digits.

output_formats
enum<string>[]
Available options:
json,
srt,
vtt
webhook_url
string<uri>

https URL to POST the signed (X-PyAI-Signature) completion callback to.

trace
boolean
default:false

Trace compliance add-on: scan + redact PII; the result carries the redacted transcript plus a trace summary (verdict, PII count). Requires the org's Trace entitlement on this surface (else 402); bills one Trace call. Not supported together with diarize/channel.

rule_pack
object

Optional Trace rule pack forwarded to the scan (only used when trace is true).

call_id
string

Optional stable call identifier for Recap; defaults to the transcription job id.

pack_id
string

Optional Recap pack id.

Pattern: ^[a-z0-9_]+$
call_direction
enum<string>

Optional Recap call direction.

Available options:
inbound,
outbound
customer_name
string

Optional Recap customer label.

language
enum<string>

Optional Recap summarization language.

Available options:
en,
fr,
es,
de,
hi
crm_fields
object

Optional CRM metadata delivered durably with the Recap trigger.

Response

Job accepted

job_id
string
Example:

"job_aZ09..."

status
enum<string>
Available options:
queued,
running,
completed,
failed,
cancelled
created_at
integer

Unix ms.

updated_at
integer

Unix ms.

result
object

Present on completed jobs (inline). Large results are offloaded to result_url instead.

result_url
string<uri>

Signed GET URL for an offloaded large result.

error
string

Present on failed jobs.