Publishing · Tools

Download a TikTok video

Downloads a TikTok video. Works with TikTok accounts.

GEThttps://api.pozy.ai/v1/tools/tiktok/download
TikTokdownloadTikTokVideo

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the publishing resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

NameTypeNotes
urlrequiredstring
actionstringOne of download, formatsDefault download
formatIdstring

Example

curl -X GET "https://api.pozy.ai/v1/tools/tiktok/download?url=https%3A%2F%2Fpozy.ai%2Fmedia%2Fexample-1.jpg" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successbooleanrequired
  • titlestringrequired
  • formatstring
  • downloadUrlstring
  • durationnumber
  • coverstring
  • formatsarray of object
    9 child fields
    • idstring
    • labelstring
    • extstring
    • typestring
    • heightnumber
    • widthnumber
    • fpsnumber
    • hasAudioboolean
    • hasVideoboolean
200 response
{
  "success": true,
  "title": "Launch day",
  "format": "string",
  "downloadUrl": "https://pozy.ai/media/example-1.jpg",
  "duration": 12.5,
  "cover": "string",
  "formats": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "label": "string",
      "ext": "string",
      "type": "string",
      "height": 12.5,
      "width": 12.5,
      "fps": 12.5,
      "hasAudio": true,
      "hasVideo": true
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.