{ "openapi": "3.0.1", "info": { "title": "Social Video Product Placement Detector", "version": "2.0", "x-build-id": "iF6nnluBo1cltkg3r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kayhermes~social-video-product-placement-detector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kayhermes-social-video-product-placement-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/kayhermes~social-video-product-placement-detector/runs": { "post": { "operationId": "runs-sync-kayhermes-social-video-product-placement-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/kayhermes~social-video-product-placement-detector/run-sync": { "post": { "operationId": "run-sync-kayhermes-social-video-product-placement-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", "properties": { "videos": { "title": "videos", "type": "array", "description": "Detect product placement signals from supplied transcripts, OCR, logos, objects, links, promo codes, commercial language, and disclosures.", "default": [ { "videoId": "video-1", "creatorId": "creator-9", "caption": "Use code GLOW20 and shop now for Lumina Glow Serum #ad", "openingTranscript": "Lumina serum changed my routine", "detectedLogos": [ "lumina logo" ], "objectLabels": [ "serum bottle" ], "links": [ "https://lumina.example/products/glow" ] }, { "videoId": "video-2", "caption": "Buy now, link in bio for AquaMax bottle", "links": [ "https://aquamax.example/bottle" ], "disclosureFlag": false } ] }, "datasetId": { "title": "Source Dataset ID", "type": "string", "description": "Optional Apify dataset ID containing video records to analyze." }, "sourceUrls": { "title": "CSV or JSON source URLs", "type": "array", "description": "Optional URLs pointing to CSV or JSON files containing video records.", "default": [] }, "options": { "title": "Analysis options", "type": "object", "description": "Optional analysis settings that control detector behavior.", "default": {} }, "stateStoreName": { "title": "Optional named state store", "type": "string", "description": "Optional named key-value store used to persist processing state." }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of source records to process in one run.", "default": 10000 }, "webhookUrl": { "title": "Alert or completion webhook", "type": "string", "description": "Optional webhook URL that receives alert or completion notifications." }, "productCatalog": { "title": "Product catalog", "type": "array", "description": "Products, brands, aliases, domains, logo labels, and object labels to match.", "default": [ { "productId": "p1", "productName": "Glow Serum", "brand": "Lumina", "aliases": [ "lumina serum" ], "domains": [ "lumina.example" ], "logoLabels": [ "lumina logo" ], "objectLabels": [ "serum bottle" ] }, { "productId": "p2", "productName": "Hydra Bottle", "brand": "AquaMax", "aliases": [ "aquamax bottle" ], "domains": [ "aquamax.example" ] } ] } } }, "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 } } } } } } } } } }