Skip to main content
GET
Get batch results
Paginated batch results endpoint.

Query params

  • status (optional): completed, failed, retrying, processing
  • page (default: 1)
  • limit (default: 50, max: 200)
  • raw (default: false)
    • false: merged per-file results
    • true: raw per-job records
  • chunks (optional bool): include chunk-level details inline
  • speech_information (optional bool): include segment-level speech information (tone, accent, speaker_id, timestamps, etc.)

Example (merged, completed only)

Example (raw job records)

Typical response shapes

  • raw=false: { batch_id, page, limit, total_pages, total_files, count, files: [...] }
  • raw=true: { batch_id, page, limit, total_pages, total_jobs, count, jobs: [...] }
  • Missing batch with no status filter: { "error": "batch not found" }

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id
string
required

Query Parameters

status
enum<string>
Available options:
completed,
failed,
retrying,
processing
page
integer
default:1
Required range: x >= 1
limit
integer
default:50
Required range: 1 <= x <= 200
raw
boolean
default:false
chunks
boolean
speech_information
boolean

Include segment-level speech information (tone, accent, speaker_id, timestamps, etc.)

Response

Batch results response

batch_id
string
page
integer
limit
integer
total_pages
integer
total_files
integer
count
integer
files
object[]