Skip to main content
POST
/
v1
/
transcription
/
jobs
Create an async transcription job
curl --request POST \
  --url https://api.pyai.com/v1/transcription/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audio_url": "<string>",
  "model": "pyai-hear-telephony",
  "channel": false,
  "diarize": false,
  "numerals": false,
  "output_formats": [
    "json"
  ],
  "webhook_url": "<string>"
}
'
{
  "job_id": "job_aZ09...",
  "created_at": 123,
  "updated_at": 123,
  "result": {
    "text": "<string>",
    "speakers": 123,
    "audio_seconds": 123,
    "segments": [
      {
        "id": 123,
        "start": 123,
        "end": 123,
        "text": "<string>",
        "speaker": "<string>",
        "channel": 123
      }
    ],
    "words": [
      {}
    ],
    "formats": {}
  },
  "result_url": "<string>",
  "error": "<string>"
}

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.

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.