TikTok

Video transcript

A video's captions, as one text and as timed segments. A video without them answers NOT_FOUND.

GET/v1/tiktok/videos/transcript1 credit
x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

3
video_idstringoptionalquery

A video's or photo post's id: the digits after /video/ or /photo/ in its link. Give video_id or url.

example: 7587811642650545421

urlstringoptionalquery

A video's or photo post's link: tiktok.com/@handle/video/<id> or /photo/<id>. Not a short link (vm.tiktok.com): open it, and copy the link it leads to. Give video_id or url.

max 300 chars

languagestringoptionalquery

Which captions: a language as the video endpoint's captions code it, such as eng-US. When left out, the language spoken in the video, else its first captions.

Response fields

19
dataobject

The result: one object, or a list for the endpoints that return several.

data.video_idstring

The video's id.

data.languagestring

The captions' language, as TikTok codes it: eng-US.

data.textstring

The whole transcript: every segment's text, joined.

data.segmentsarray

The captions in order, each with its start and end.

data.segments[].startnumber

When the caption starts, in seconds from the video's start.

data.segments[].endnumber

When it ends, in seconds.

data.segments[].textstring

What is said.

pageobjectnullable

Paging, for the endpoints that page; null for the others.

page.next_cursorstringnullable

Send it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.

page.has_morebooleanoptional

Whether another page follows.

default: false

metaobject

About this call.

meta.platformstring

The platform: reddit, threads, tiktok or youtube.

meta.endpointstring

The endpoint's name, such as channel_videos.

meta.paramsobject

The call's parameters, defaults included. Parameters without a value, and the cursor, are left out.

meta.request_idstring

This call's id. Quote it when you report a problem.

meta.api_versionstring

The API version that answered.

meta.fetched_atstring

When the data was fetched from the platform (UTC).

format: date-time

meta.cachedbooleanoptional

Whether it came from our cache; fetched_at says how old it is.

default: false

Code example

curl -X GET 'https://api.socialparse.dev/v1/tiktok/videos/transcript?video_id=7587811642650545421' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": {    "video_id": "string",    "language": "string",    "text": "string",    "segments": [      {        "start": 0,        "end": 0,        "text": "string"      }    ]  },  "page": {    "next_cursor": "string",    "has_more": false  },  "meta": {    "platform": "string",    "endpoint": "string",    "params": {      "property1": "string",      "property2": "string"    },    "request_id": "string",    "api_version": "string",    "fetched_at": "2019-08-24T14:15:22Z",    "cached": false  }}