Read a job

GET /v1/jobs/{job_id}

Answers one job with its status, progress and result (1.52.0). The api also requires the permission JOB_TYPE_PERMISSIONS names for the job type (webhooks:write for webhook.replay); a job the caller lacks it for is not_found to it and absent from its list.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the jobs:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/jobs/job_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/jobs/job_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/jobs/job_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is Job.