SPspeechmatics

Get job details

Changed on

Get job details, including progress and any error reports.

get/jobs/{jobid}

Request

Path parameters

jobidstring required

ID of the job.

Query parameters

waitinteger

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.

Response

OK

Example response

{
  "job": {
    "created_at": "2018-01-09T12:29:01.853047Z",
    "data_name": "recording.mp3",
    "duration": 244,
    "id": "a1b2c3d4e5",
    "status": "transcribing",
    "type": "transcription",
    "transcription_config": {
      "language": "en",
      "additional_vocab": [
        {
          "content": "Speechmatics",
          "sounds_like": [
            "speechmatics"
          ]
        },
        {
          "content": "gnocchi",
          "sounds_like": [
            "nyohki",
            "nokey",
            "nochi"
          ]
        },
        {
          "content": "CEO",
          "sounds_like": [
            "C.E.O."
          ]
        },
        {
          "content": "financial crisis"
        }
      ],
      "diarization": "channel",
      "channel_diarization_labels": [
        "Agent",
        "Caller"
      ]
    },
    "notification_config": [
      {
        "url": "https://collector.myorg.com/callback",
        "contents": [
          "transcript",
          "data"
        ],
        "auth_headers": [
          "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM"
        ]
      }
    ],
    "tracking": {
      "title": "ACME Q12018 Statement",
      "reference": "/data/clients/ACME/statements/segs/2018Q1-seg8",
      "tags": [
        "quick-review",
        "segment"
      ],
      "details": {
        "client": "ACME Corp",
        "segment": 8,
        "seg_start": 963.201,
        "seg_end": 1091.481
      }
    }
  }
}

Changes