UDL's Main Processing Endpoint

POST /api/json

Process download requests and configure output

Headers

  • Accept string

    Accept header

    Value is application/json.

application/json

Body Required

  • url string(uri) Required
  • vCodec string

    Values are h264, av1, or vp9.

  • vQuality string

    Values are 144, 240, 360, 480, 720, 1080, 1440, 2160, or max.

  • aFormat string

    Values are best, mp3, ogg, wav, or opus.

  • filenamePattern string

    Values are classic, pretty, basic, or nerdy.

  • isAudioOnly boolean
  • isNoTTWatermark boolean
  • isTTFullAudio boolean
  • isAudioMuted boolean
  • dubLang boolean
  • disableMetadata boolean
  • twitterGif boolean

Responses

  • 200 application/json

    Successful Operation

    Hide response attributes Show response attributes object
    • status string

      Values are error, redirect, stream, success, rate-limit, or picker.

    • text string
    • url string(uri)
    • pickerType string
    • picker array[object]
      Hide picker attributes Show picker attributes object
      • type string

        Value is video.

      • url string(uri)
      • thumb string(uri)
    • audio string(uri)
POST /api/json 
curl \
 -X POST https://udl.rocord.dev/api/json \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"url":"https://example.com","vCodec":"h264","vQuality":"144","aFormat":"best","filenamePattern":"classic","isAudioOnly":true,"isNoTTWatermark":true,"isTTFullAudio":true,"isAudioMuted":true,"dubLang":true,"disableMetadata":true,"twitterGif":true}'
Request example 
# Headers
Accept: application/json

# Payload
{
  "url": "https://example.com",
  "vCodec": "h264",
  "vQuality": "144",
  "aFormat": "best",
  "filenamePattern": "classic",
  "isAudioOnly": true,
  "isNoTTWatermark": true,
  "isTTFullAudio": true,
  "isAudioMuted": true,
  "dubLang": true,
  "disableMetadata": true,
  "twitterGif": true
}
Response examples (200) 
{
  "status": "error",
  "text": "string",
  "url": "https://example.com",
  "pickerType": "string",
  "picker": [
    {
      "type": "video",
      "url": "https://example.com",
      "thumb": "https://example.com"
    }
  ],
  "audio": "https://example.com"
}