DocsAPI referenceOperations

Transcribe speech

What is said in input, as three files: JSON with each segment and its times, SubRip and WebVTT. language is required, en or pl. Times are on the clock of input. Creates the same Job as POST /v1/jobs, with operation set.

POST /v1/transcribe

Needs an API key: Authorization: Bearer $VIDEXO_API_KEY.

Parameters

Parameters
Name	In	Type	Description
`idempotency-key`	header	string, up to 255 characters	Makes retries safe for 24 hours. Up to 255 printable ASCII characters. One key space per account across every endpoint that creates a job.

Body TranscribeRequest

Body fields
Name	Type	Description
`input` required	string or object	An http or https URL, `videxo://uploads/<upload_id>`, `{ "url" }` or `{ "upload_id" }`.
`extra_inputs`	map of string to string or object
`webhook_url`	string, URL, up to 2,048 characters or null	An https URL that gets the job when it ends (M4).
`metadata`	map of string to string, up to 500 characters	Your own string pairs, returned with the job and its webhook: at most 20 keys of up to 40 characters, values up to 500.
`filename`	string, up to 105 characters	The stored file name, `<name>.<format>` by default; one extension, matching `format`.
`format`	string	`json`, the only format.
`trim`	object	The part of the input to use: `start`, and `end` or `duration`.
`language` required	one of `en`, `pl`	The language spoken, `en` or `pl`. It is never detected.

Request

bash

curl "$VIDEXO_API_URL/v1/transcribe" \
  -H "Authorization: Bearer $VIDEXO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "https://videxo.io/samples/talk.mp4",
  "language": "en"
}'

JavaScript

const response = await fetch(`${process.env.VIDEXO_API_URL}/v1/transcribe`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VIDEXO_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "input": "https://videxo.io/samples/talk.mp4",
    "language": "en"
  }),
});
const job = await response.json();

Response

202 JSON

{
  "id": "job_3k9x0c2mfq8w1n7r5t4b6v2z",
  "state": "queued",
  "kind": "operations",
  "operation": "transcribe",
  "spec": {
    "inputs": {
      "source": {
        "url": "https://videxo.io/samples/talk.mp4"
      }
    },
    "outputs": [
      {
        "name": "transcript",
        "type": "transcript",
        "input": "source",
        "filename": "transcript.json",
        "format": "json",
        "language": "en"
      }
    ]
  },
  "command": null,
  "input_files": null,
  "output_files": null,
  "ffmpeg_command": null,
  "steps": [
    {
      "tool": "ffmpeg",
      "inputs": [
        "source"
      ],
      "outputs": [],
      "command": "ffmpeg -i https://videxo.io/samples/talk.mp4 -map 0:a:0 -map_metadata -1 -ac 1 -ar 16000 -c:a pcm_s16le audio_1.wav"
    },
    {
      "tool": "whisper",
      "inputs": [
        "source"
      ],
      "outputs": [
        "transcript"
      ],
      "command": null
    }
  ],
  "webhook_url": null,
  "metadata": {},
  "progress": null,
  "error": null,
  "outputs": [],
  "usage": null,
  "created_at": "2026-11-04T12:00:00.000Z",
  "started_at": null,
  "finished_at": null
}

Responses

Responses
Status	Body	When
200	Job	The job this Idempotency-Key made earlier (same endpoint and body).
202	Job	The job, queued.
400	Problem	invalid_request (with `errors`) or command_invalid (with `problems`)
401	Problem	authentication_failed (missing_api_key, invalid_api_key, api_key_revoked, api_key_expired)
402	Problem	out_of_credits
403	Problem	permission_denied (account_disabled, token_scope)
404	Problem	not_found (upload)
409	Problem	conflict (idempotency_key_reused)
413	Problem	limit_exceeded (request_body_size): the body is larger than 512 KB
415	Problem	invalid_request (not_json): the body is not sent as application/json
429	Problem	rate_limited, with Retry-After in seconds: requests over the limit, or `waiting_jobs` for an account at its limit of jobs waiting
500	Problem	internal_error
503	Problem	service_unavailable (temporary): the account's free credits are still being granted, or a part of the service did not answer