{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Transcript - Spoken Hook, CTA, Offer & Angle", "description": "Get the transcript of Facebook and Instagram video ads from the Meta Ad Library with the spoken hook (first 5 s), CTA, offer and angle. Search by keyword, Page ID or Ad Library link, or monitor new ads only. $25 per 1,000 video ads, $6 per 1,000 image or text ads; no-speech ads free.", "version": "1.0", "x-build-id": "sby81KPLlnnfJvo2m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tenfoldfleet~facebook-ads-transcript/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tenfoldfleet-facebook-ads-transcript", "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/tenfoldfleet~facebook-ads-transcript/runs": { "post": { "operationId": "runs-sync-tenfoldfleet-facebook-ads-transcript", "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/tenfoldfleet~facebook-ads-transcript/run-sync": { "post": { "operationId": "run-sync-tenfoldfleet-facebook-ads-transcript", "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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search in the Meta Ad Library, one per line (a product, a niche, a brand or a phrase). Each term is one query.", "items": { "type": "string" } }, "pageIds": { "title": "Advertiser Page IDs", "type": "array", "description": "Facebook Page IDs of advertisers, to transcribe the ads of one brand. The ID is the number after view_all_page_id= in an Ad Library link (you can paste that whole link here too).", "items": { "type": "string" } }, "adLibraryUrls": { "title": "Ad Library URLs", "type": "array", "description": "Search links copied from https://www.facebook.com/ads/library/ after you set filters there. The filters in the link are used as they are.", "items": { "type": "string" } }, "mediaType": { "title": "Media type", "enum": [ "video", "all", "image", "none" ], "type": "string", "description": "Video ads only (the default), or all ads. With all ads, image and text ads come back as plain rows at the lower ad-row price.", "default": "video" }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code of the market where the ads ran (US, GB, DE, FR, AU, BR...), or ALL for every country.", "default": "US" }, "activeStatus": { "title": "Active status", "enum": [ "active", "all", "inactive" ], "type": "string", "description": "Only ads running now, only ads that stopped, or both.", "default": "active" }, "exactPhrase": { "title": "Exact phrase", "type": "boolean", "description": "Match the search term as an exact phrase instead of any of its words.", "default": false }, "maxAdsPerQuery": { "title": "Max ads per query", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop each search term, Page or URL after this many ads (up to 1,000). On the Apify Free plan the run also stops when your monthly free credit runs out.", "default": 20 }, "onlyNewSince": { "title": "Only new ads since", "type": "string", "description": "Leave empty for every ad. Type lastRun to get (and pay for) only ads that earlier runs of this monitor did not return: schedule the same input daily or weekly to see each new creative once. Or a date (YYYY-MM-DD) to keep only ads that started on or after it." }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional name for the lastRun memory, for example competitors-skincare. Without it the memory is tied to the exact search terms, Page IDs and filters." }, "maxMinutesPerVideo": { "title": "Max minutes per video", "minimum": 1, "maximum": 10, "type": "integer", "description": "Transcribe at most this many minutes of each video. One video ad event covers 3 minutes of audio; each further started 3 minutes is one more event. Most ads are under 1 minute; the limit is 10 minutes.", "default": 6 }, "language": { "title": "Spoken language", "type": "string", "description": "Leave on auto to detect it per ad, or give a two-letter code (en, es, de, fr, pt...) when you know it.", "default": "auto" }, "includeTranscriptSegments": { "title": "Timed transcript segments", "type": "boolean", "description": "Also return the transcript as sentences with start and end times in seconds.", "default": false }, "maxConcurrency": { "title": "Parallel queries", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many queries to load at the same time. Keep it low: Meta slows down sessions that load too fast.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy is the default and its cost is included in the price. Datacenter IPs only get about 30 ads per query before Meta limits them.", "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 } } } } } } } } } }