Request body
sourceUrl— TikTok share link or canonical URL. Required iffileis not provided.file— Optional uploaded video file (multipart/form-data).sourceName— Optional label saved with the transcript.options— Optional object. Supported keys:transcriptionModel— Preferred transcription backend (whisper-large-v3, etc.).segmentLength— Target characters per chunk (default600).includeCaptions— Boolean; merge official captions when present (defaulttrue).
webhookUrl— Optional HTTPS URL Horizon should call when the extraction finishes.
Sample request
Response
Returns202 Accepted with jobId, status, statusUrl, and optional etaSeconds. Completed jobs include transcript chunks, TikTok details (author handle, publish time, hashtags), and audio track info.
Notes
- Only public videos are supported; private or subscribers-only content cannot be fetched.
- If TikTok throttles access, the job automatically retries with backoff before failing.
- Provide campaign labels in your datastore to keep downstream analytics organized.
- Poll
GET /jobs/{jobId}(equivalent tostatusUrl) to check progress or retrieve the final transcript and accompanying details later. - To upload a downloaded TikTok video, send
multipart/form-datawith afilefield instead ofsourceUrl.
x402 flow
TikTok extraction is priced via Coinbase’s x402 protocol. When a payment proof is missing, Horizon sends:accepts payload to your facilitator, execute /verify and /settle, then replay the extraction request with the Base64 token in X-PAYMENT. Horizon finalizes the job and returns settlement details in X-PAYMENT-RESPONSE.Body
application/json
Provide either sourceUrl or file.
Extraction hints such as language, segmentLength, transcriptionModel, or sheet preferences depending on the endpoint.
Webhook to call when the extraction completes.
Upload the raw file instead of providing sourceUrl.
Response
Extraction job accepted
Example:
"job_01hx9q9"
Available options:
queued, processing, completed, failed Canonical link to GET /jobs/{jobId} for this job.
Example:
"extract/pdf"
Present when the job completes synchronously.
Estimated seconds until completion.