اسناد API

API مربوط به TTOK.com در TTOK.com میزبانی می‌شود.

احراز هویت

برای دسترسی به API تیکت، باید کلید API منحصر به فرد خود را وارد کنید. می‌توانید با ثبت نام با آدرس ایمیل خود، کلید API را دریافت کنید. لطفاً به یاد داشته باشید که کلید API خود را محرمانه نگه دارید.

احراز هویت با API از طریق هدرهای HTTP انجام می شود. همه درخواست‌ها به یک سرصفحه مجوز نیاز دارند که حاوی کلید API شما در کلید قالب باشد: YOUR_API_KEY ، که در آن YOUR_API_KEY کلید موجود در صفحه حساب شما است.

برای امنیت، همه درخواست ها باید از طریق یک اتصال HTTPS رمزگذاری شده ارسال شوند تا از داده های شما در حین انتقال محافظت شود.

Download Endpoint

Extract media from any supported URL with a single synchronous request. No polling required.

POST https://api.ttok.com/api/download

Parameter	Type	Description
`url`	string	The URL to extract media from (JSON body)

Headers: Authorization: YOUR_API_KEY, Content-Type: application/json

import requests

headers = {
    "Authorization": "API_KEY",
    "Content-Type": "application/json"
}
r = requests.post(
    url="https://api.ttok.com/api/download",
    headers=headers,
    json={"url": "URL"}
)

if r.status_code == 200:
    data = r.json()
    for item in data.get("items", []):
        print(f"Type: {item['type']}, URL: {item['url']}")
else:
    print(f"Error: {r.status_code} - {r.text}")

const axios = require('axios');

async function download() {
    try {
        const response = await axios.post(
            'https://api.ttok.com/api/download',
            { url: "URL" },
            { headers: { "Authorization": "API_KEY", "Content-Type": "application/json" } }
        );

        for (const item of response.data.items) {
            console.log(`Type: ${item.type}, URL: ${item.url}`);
        }
    } catch (error) {
        console.error(`Error: ${error.response?.status} - ${error.response?.data}`);
    }
}

download();

<?php

$ch = curl_init("https://api.ttok.com/api/download");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: API_KEY",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["url" => "URL"]));

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($statusCode === 200) {
    $data = json_decode($response, true);
    foreach ($data['items'] as $item) {
        echo "Type: {$item['type']}, URL: {$item['url']}\n";
    }
} else {
    echo "Error: $statusCode - $response\n";
}

?>

curl -X POST "https://api.ttok.com/api/download" \
  -H "Authorization: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "URL"}'

Response

{
    "success": true,
    "items": [
        {
            "url": "https://...",
            "type": "video",
            "thumbnail": "https://...",
            "mime_type": "video/mp4",
            "site": "tiktok",
            "title": "Video title"
        }
    ]
}

Conversion Endpoints

Convert media to different formats. Returns a binary file stream.

Endpoint	Output Format	Content-Type
`POST /api/convert/mp3`	MP3 audio	audio/mpeg
`POST /api/convert/mp4`	MP4 video	video/mp4
`POST /api/convert/wav`	WAV audio	audio/wav
`POST /api/convert/gif`	GIF image	image/gif

All conversion endpoints are at https://api.ttok.com.

Request body (JSON):

Parameter	Type	Required	Description
`url`	string	Yes	The media URL to convert
`options.start_time`	number	No	Start time in seconds
`options.end_time`	number	No	End time in seconds
`options.audio_quality`	string	No	Audio bitrate (e.g. "128", "192", "320")
`options.video_quality`	string	No	Video quality (e.g. "720", "1080")
`options.h264`	boolean	No	Force H.264 codec for MP4
`options.subtitles`	boolean	No	Embed subtitles if available

Example: Convert to MP3

import requests

headers = {
    "Authorization": "API_KEY",
    "Content-Type": "application/json"
}

r = requests.post(
    url="https://api.ttok.com/api/convert/mp3",
    headers=headers,
    json={
        "url": "URL",
        "options": {
            "audio_quality": "192",
            "start_time": 10,
            "end_time": 45
        }
    },
    stream=True
)

if r.status_code == 200:
    with open("output.mp3", "wb") as f:
        for chunk in r.iter_content(chunk_size=8192):
            f.write(chunk)
    print("Downloaded output.mp3")
else:
    print(f"Error: {r.status_code} - {r.text}")

curl -X POST "https://api.ttok.com/api/convert/mp3" \
  -H "Authorization: API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "URL", "options": {"audio_quality": "192"}}' \
  --output output.mp3

Error Handling

All errors return a JSON response with an error field:

// 400 Bad Request
{"error": "Missing URL"}

// 401 Unauthorized
{"error": "Invalid API token"}

// 402 Payment Required
{"error": "Insufficient credits"}