For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages can be requested by appending `.md` to the URL, or by setting the `Accept` header to `text/markdown`.
Skip to main content
Transcription API

Get job details

GET https://eu1.asr.api.speechmatics.com/v2/jobs/{jobid}

Get job details, including progress and any error reports.

Authentication

  • bearerAuth Authorization: Bearer <token>

    Your API key, or a temporary key (JWT).

Path parameters

jobid
string

ID of the job.

Query parameters

wait
integer
optional

Note: Only available on SaaS on Cloud. Number of seconds to block until the job reaches a terminal state before responding. Capped server-side. The response is always returned with HTTP 200 in the job's current state; if the job is still running when wait elapses, retry to keep waiting. When omitted, a short default wait applies: currently 5 seconds, and it will increase. Treat the default as an unspecified short interval rather than a fixed duration. Pass wait=0 to respond immediately.

Responses

OK

application/json application/vnd.speechmatics.v2+json
job
JobDetails

Document describing a job. JobConfig will be present in JobDetails returned for GET jobs/{id} request in SaaS and in Batch Appliance, but it will not be present in JobDetails returned as item in RetrieveJobsResponse in case of Batch Appliance.

Request

import { BatchClient } from "@speechmatics/batch-client";

const client = new BatchClient({ apiKey: "YOUR_API_KEY", appId: "my-app" });

const { job } = await client.getJob("JOB_ID");
console.log(job.status);

Examples