{ "openapi": "3.0.1", "info": { "title": "YouTube Sponsor Segment Detector", "description": "Detect sponsor segments, promo codes, and brand deals in any YouTube video. Returns exact ad timestamps with community vote scores, plus discount codes and percentages pulled from the description, and channel, views, and publish date. No login.", "version": "1.0", "x-build-id": "ZFVZhi2k0y4OJOT5e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~youtube-sponsor-detector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-youtube-sponsor-detector", "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/xtracto~youtube-sponsor-detector/runs": { "post": { "operationId": "runs-sync-xtracto-youtube-sponsor-detector", "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/xtracto~youtube-sponsor-detector/run-sync": { "post": { "operationId": "run-sync-xtracto-youtube-sponsor-detector", "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": [ "videoUrls" ], "properties": { "videoUrls": { "title": "YouTube videos", "type": "array", "description": "YouTube videos to analyze for sponsor segments. Accepts 11-character video IDs, full watch URLs (https://www.youtube.com/watch?v=...), short links (https://youtu.be/...), and Shorts URLs.", "items": { "type": "string" } }, "channelUrl": { "title": "Channel (optional)", "type": "string", "description": "Optionally analyze a channel's most recent uploads instead of (or in addition to) the videos above. Accepts a channel handle (@LinusTechTips), channel URL, or channel ID (UC...)." }, "maxVideos": { "title": "Max videos from channel", "minimum": 1, "maximum": 100, "type": "integer", "description": "When a channel is provided, how many of its most recent uploads to analyze.", "default": 10 }, "categories": { "title": "Segment categories", "type": "array", "description": "Which kinds of segment to detect. Sponsor and self-promotion are the paid-deal categories; the rest cover intros, outros, and filler.", "items": { "type": "string", "enum": [ "sponsor", "selfpromo", "interaction", "intro", "outro", "music_offtopic", "filler" ], "enumTitles": [ "Paid sponsor read", "Self / channel promotion", "Interaction reminder (like & subscribe)", "Intro / intermission", "Outro / endcards", "Non-music section (music videos)", "Filler / tangent" ] }, "default": [ "sponsor", "selfpromo" ] }, "includeTranscriptMatch": { "title": "Include spoken text for sponsor segments", "type": "boolean", "description": "When on, attaches the words spoken during each sponsor / self-promotion segment (from the video's captions) plus a best-guess brand name. Adds extra processing time.", "default": false }, "usePrivacyHash": { "title": "Privacy-preserving lookup", "type": "boolean", "description": "When on, looks up segments without sending the full video ID to the segment database. Slightly slower; same results.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of videos to output across all inputs.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Residential is recommended because YouTube rate-limits datacenter networks.", "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 } } }, "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 } } } } } } } } } }