SPspeechmatics

Create a new job

post/jobs

Request

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. When set, the response includes a status field reporting the outcome, and on done the transcript is embedded under the requested format key when available. When omitted, the request returns as soon as the job is created and status is not included.

format'json-v2' | 'txt' | 'srt'

Note: Only available on SaaS on Cloud, and only applies when wait is set. Format of the transcript embedded in the response when the job finishes within wait. Defaults to json-v2.

Headers

X-SM-Processing-Datastring

Note: Only available for on-prem JSON dictionary of processing settings for the job worker. Currently supports parallel_engines (integer), which controls the number of engines the worker can use in parallel for this job, and user_id (string), which is the user id for this job. Example: {"parallel_engines": 4}

Request body multipart/form-data

configstring required

JSON containing a JobConfig model indicating the type and parameters for the recognition job.

data_filestring binary

The data file to be processed. Alternatively the data file can be fetched from a url specified in JobConfig.

Response

OK

idstring required

The unique ID assigned to the job. Keep a record of this for later retrieval of your completed job.

status'created' | 'done' | 'rejected' | 'deleted'

Note: Only available on SaaS on Cloud. Present only when the wait query parameter is set. Reports the outcome of the wait, which is distinct from the job lifecycle status returned by GET /jobs/{jobid}. * created - the job was created and is still running, or wait elapsed before it finished. * done - the job finished; the transcript is embedded under the requested format key when available. * rejected - the job could not be processed. * deleted - the job was deleted before it could finish.

txtstring

Note: Only available on SaaS on Cloud. The transcript in plain text, embedded when status is done and format was txt. Best-effort: if absent, fetch it from GET /jobs/{jobid}/transcript.

srtstring

Note: Only available on SaaS on Cloud. The transcript in SRT format, embedded when status is done and format was srt. Best-effort: if absent, fetch it from GET /jobs/{jobid}/transcript.

Example response

{
  "id": "a1b2c3d4e5"
}

Changes

No recorded changes to this operation across all 1 revision of this API.