{
  "openapi": "3.0.1",
  "info": {
    "title": "Video On-Screen Text Extractor (OCR) for Reels & TikTok",
    "description": "Read the text shown in TikToks, Instagram Reels, X and Facebook videos: captions, titles, list items and burned-in subtitles, in order of appearance and without watermarks. Ideal for music-only videos. Includes the spoken transcript. About $0.008 per video.",
    "version": "0.1",
    "x-build-id": "uaHjMbm17kWVAylCr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/aemon~video-on-screen-text-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-aemon-video-on-screen-text-extractor",
        "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/aemon~video-on-screen-text-extractor/runs": {
      "post": {
        "operationId": "runs-sync-aemon-video-on-screen-text-extractor",
        "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/aemon~video-on-screen-text-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-aemon-video-on-screen-text-extractor",
        "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": "Video URLs",
            "minItems": 1,
            "type": "array",
            "description": "Links to TikTok videos, Instagram Reels, X posts with video or public Facebook videos, one per line. YouTube is not supported for on-screen text.",
            "items": {
              "type": "string",
              "pattern": "^https?://(([a-z0-9-]+\\.)?tiktok\\.com|(www\\.)?instagram\\.com|(www\\.)?(x|twitter)\\.com|([a-z0-9-]+\\.)?facebook\\.com|fb\\.watch|(www\\.)?fb\\.com)/.+"
            }
          },
          "maxVideosPerUrl": {
            "title": "Videos per TikTok profile",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "For profiles, playlists, channels and podcast feeds: how many of the newest videos to transcribe. Single video URLs always produce one result.",
            "default": 1
          },
          "publishedAfter": {
            "title": "Only videos published after",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "For profiles, channels and playlists: skip videos published before this date (YYYY-MM-DD). Skipped videos are free. Single video links are never filtered.",
            "default": ""
          },
          "extractOnScreenText": {
            "title": "📝 Read on-screen text (+$0.002 per video)",
            "type": "boolean",
            "description": "Also read the text shown in the video itself: captions, titles, list items and burned-in subtitles. Great for Reels and TikToks that use music instead of speech. Not available for YouTube.",
            "default": true
          },
          "aiAnalysis": {
            "title": "🤖 AI analysis: summary, hook, key points & CTA (+$0.004 per video)",
            "type": "boolean",
            "description": "Adds an AI breakdown of each video: a short summary, the opening hook, key points, the call to action, topics, content type and sentiment. Great for competitor and creator research.",
            "default": false
          },
          "translateTo": {
            "title": "🌍 Translate transcript to (+$0.003 per 1,000 words)",
            "enum": [
              "none",
              "en",
              "es",
              "pt",
              "fr",
              "de",
              "it",
              "nl",
              "pl",
              "cs",
              "sk",
              "ru",
              "uk",
              "tr",
              "ar",
              "hi",
              "id",
              "vi",
              "th",
              "ja",
              "ko",
              "zh",
              "sv",
              "da",
              "no",
              "fi",
              "el",
              "he",
              "ro",
              "hu"
            ],
            "type": "string",
            "description": "Also returns the transcript translated into this language with AI. Charged per started 1,000 words; transcripts already in this language are returned as they are and not charged.",
            "default": "none"
          },
          "language": {
            "title": "Spoken language",
            "enum": [
              "auto",
              "en",
              "es",
              "pt",
              "fr",
              "de",
              "it",
              "nl",
              "pl",
              "cs",
              "sk",
              "ru",
              "uk",
              "tr",
              "ar",
              "hi",
              "id",
              "vi",
              "th",
              "ja",
              "ko",
              "zh",
              "sv",
              "da",
              "no",
              "fi",
              "el",
              "he",
              "ro",
              "hu"
            ],
            "type": "string",
            "description": "Language spoken in the videos. Auto-detect works for 90+ languages; pick a language only if detection gets it wrong. This is not a translation option.",
            "default": "auto"
          },
          "preferPlatformCaptions": {
            "title": "Use platform captions when available",
            "type": "boolean",
            "description": "Use the platform's own captions (for example YouTube) when they exist in the spoken language. Faster; AI transcription is used as a fallback.",
            "default": true
          },
          "includeSegments": {
            "title": "Include timestamped segments",
            "type": "boolean",
            "description": "Add a list of segments with start and end times in seconds.",
            "default": true
          },
          "subtitleFormat": {
            "title": "Subtitle file format",
            "enum": [
              "none",
              "srt",
              "vtt"
            ],
            "type": "string",
            "description": "Also return the transcript as a ready-to-use subtitle file.",
            "default": "none"
          },
          "maxDurationMinutes": {
            "title": "Skip videos longer than (minutes)",
            "minimum": 1,
            "maximum": 600,
            "type": "integer",
            "description": "Videos longer than this are skipped and not charged.",
            "default": 120
          },
          "maxConcurrency": {
            "title": "Parallel downloads",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many videos are processed at the same time.",
            "default": 4
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Used as a fallback when a platform blocks a direct request, and always for YouTube. Residential proxies work best.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}