Sign in

v1

latestOpenAPI 3.0.02026-07-228239173.7 KB
Client API

Endpoint for requesting video transcription

post/api/v1/client/vid2txt

Headers

Accept'application/json' required

Request body

video_urlstring required

Public video URL to transcribe. Supported platforms: YouTube, TikTok, Twitch, Kick, X.

include_tsboolean required

Should transcription include timestamps

modelstring

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

return_result_in_responseboolean nullable

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

webhook_urlstring uri nullable

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.

Example request

{
  "video_url": "https://www.youtube.com/watch?v=jNQXAC9IVRw",
  "model": "WhisperLargeV3",
  "webhook_url": "https://your-server.com/webhooks/deapi"
}

Response

ID of the inference request.

Example response

{
  "data": {
    "request_id": "c08a339c-73e5-4d67-a4d5-231302fbff9a"
  }
}