{ "openapi": "3.0.1", "info": { "title": "Douyin Transcript & Subtitles API: AI Speech & Video to Text 抖音", "description": "Get Douyin transcripts (抖音) of videos: punctuated simplified Chinese with timestamps, SRT/VTT, share links and app share text accepted. No login. Music-only videos are detected and never charged.", "version": "0.1", "x-build-id": "6vmWO5Uz2hhGdLS5I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quarra~douyin-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quarra-douyin-transcript-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/quarra~douyin-transcript-scraper/runs": { "post": { "operationId": "runs-sync-quarra-douyin-transcript-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/quarra~douyin-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-quarra-douyin-transcript-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "urls" ], "properties": { "urls": { "title": "Douyin videos", "maxItems": 5000, "type": "array", "description": "One per line: video URLs (douyin.com/video/…, ?modal_id=…, iesdouyin.com/share/video/…), share links (v.douyin.com/…), the whole share text copied from the Douyin app (the link inside is used), or video IDs.", "items": { "type": "string", "maxLength": 2000 } }, "language": { "title": "Spoken language", "maxLength": 40, "type": "string", "description": "Optional. The language you expect, as a code or a name (zh, yue, en…). It is a preference, not an instruction: each video comes back in the language actually spoken (requestedLanguageFound: false when it differs); it does not translate. For English, tick Translate to English below. Empty: detected for each video. Mandarin comes back in simplified Chinese with Chinese punctuation (，。？)." }, "transcriptFormat": { "title": "Transcript format", "enum": [ "both", "text", "segments" ], "type": "string", "description": "transcript is the whole text in one string; segments is a list of {start, end, duration, text} in seconds.", "default": "both" }, "includeSrt": { "title": "Add SRT subtitles", "type": "boolean", "description": "Add an srt field: the transcript as a ready-to-save .srt subtitle file.", "default": false }, "includeVtt": { "title": "Add WebVTT subtitles", "type": "boolean", "description": "Add a vtt field: the transcript as a ready-to-save .vtt subtitle file.", "default": false }, "translateToEnglish": { "title": "Translate to English", "type": "boolean", "description": "Add an English translation of each transcript in a translation field, next to the original text (which is always kept). Paid option: $0.03 per started minute of translated video, on top of the transcript. Charged only when the translation is complete; a transcript already in English is not translated and not charged. Subtitles and segments stay in the original language. Available on paid Apify plans only.", "default": false }, "maxDurationMinutes": { "title": "Skip videos longer than (minutes)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Longer videos get a free too_long record instead of a transcript. Their length is read before anything is transcribed.", "default": 30 }, "maxItems": { "title": "Max transcripts in total", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Optional cap for the whole run, counted in charged transcripts. Respected exactly. Free records (no speech, deleted, private) do not count; they are bounded separately (100 plus 2 per transcript)." }, "proxyConfiguration": { "title": "Connection", "type": "object", "description": "Connection. Keep the default (automatic). Costs are included in the price.", "default": { "useApifyProxy": true } }, "deliveryConnector": { "title": "Send results to your app (MCP connector: Notion, Slack…)", "type": "string", "description": "Pick one of your Apify MCP connectors: at the end of each run, a summary of the results (count, the first 25 with their links, a link to the full dataset) is posted there. With a schedule and 'Only new', you get each day's new results where your team works. Nothing is sent when a run finds nothing. Notion connects in one click; Slack and Google need your own OAuth app in Apify, or use the webhook field below." }, "deliveryTarget": { "title": "Where in the app (channel, page or sheet ID)", "type": "string", "description": "Slack channel ID (C0123…), Notion page ID, Google Sheet ID… Leave empty if the app needs no target (a new Notion page is then created at the top of your workspace)." }, "deliveryWebhookUrl": { "title": "Or a webhook URL (Slack, Discord, Make, Zapier, n8n)", "type": "string", "description": "No connector needed. A Slack Incoming Webhook (hooks.slack.com/…) gets a message, a Discord channel webhook gets a message, any other URL receives the summary as JSON (title, text, count, datasetUrl, items)." }, "deliveryTool": { "title": "Connector tool (advanced)", "type": "string", "description": "Name of the connector's tool to call. Leave empty: the best tool that posts a message, creates a page or appends rows is picked, and the run log lists every tool the connector offers." }, "deliveryArguments": { "title": "Connector tool arguments (advanced)", "type": "object", "description": "Extra arguments for the tool, merged last, for example {\"channel\": \"#reddit-leads\"} or {\"parent\": {\"database_id\": \"…\"}}." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }