Skip to main content
POST
cURL
API v1 is deprecated. This version is no longer being developed — new endpoints, parameters and models are added to v2 only. Use the v2 endpoints to stay current: v2 API documentation.
Prerequisite: To ensure a successful request, you must first consult the Model Selection endpoint to identify a valid model slug, check specific limits and features, and verify LoRA availability.
TikTok requires WhisperLargeV3Ct2. A TikTok video_url sent with any other model — WhisperLargeV3 included — is rejected with 422 and nothing is charged. YouTube, Twitch VODs, X and Kick run on either model. Note that the v1 Model Selection endpoint does not list WhisperLargeV3Ct2, but v1 accepts the slug; v2 lists it normally.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
enum<string>
default:application/json
required
Available options:
application/json

Body

application/json

Video transcription parameters

video_url
string
required

Public video URL to transcribe. Supported platforms: YouTube, TikTok, Twitch, Kick, X. A TikTok URL is only accepted with model: WhisperLargeV3Ct2 — paired with any other model it is rejected with 422.

Example:

"https://www.youtube.com/watch?v=jNQXAC9IVRw"

include_ts
boolean
required

Should transcription include timestamps. Required - send false for plain text or true for timestamped segments.

Example:

false

model
string
required

The model to use for transcription. Available models can be retrieved via the GET /api/v1/client/models endpoint.

Example:

"WhisperLargeV3"

return_result_in_response
boolean | null
default:false

If true, the result will be returned directly in the response instead of only download url. Optional parameter.

Example:

false

webhook_url
string<uri> | null

Optional HTTPS URL to receive webhook notifications for job status changes (processing, completed, failed). Must be HTTPS. Max 2048 characters. See Webhook Documentation for payload structure and authentication details.

Maximum string length: 2048
Example:

"https://your-server.com/webhooks/deapi"

Response

ID of the inference request.

data
object

Information from success endpoint