# Videosignal (`vs.ai/videosignal`) Actor VideoSignal lets you collect videos or images from end users through a browser capture page, then notifies your backend when uploads are complete. What This Actor Does This actor creates a new VideoSignal capture link by calling the VideoSignal API and writes the link details to the Actor dataset. - **URL**: https://apify.com/vs.ai/videosignal.md - **Developed by:** [videosignal.ai](https://apify.com/vs.ai) (community) - **Categories:** Videos, AI - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## VideoSignal Capture Link Actor Generate secure VideoSignal capture links, send them to users, and receive uploaded media via webhook. ### What VideoSignal Does VideoSignal lets you collect videos or images from end users through a browser capture page, then notifies your backend when uploads are complete. ### What This Actor Does This actor creates a new VideoSignal capture link by calling the VideoSignal API and writes the link details to the Actor dataset. It does **not** upload media itself. End users upload media when they open the generated link. ### How Video Links Are Generated 1. Actor reads input (`apiKey`, `webhookUrl`, optional settings). 2. Actor calls `POST /api/v1/capture-links` on VideoSignal. 3. VideoSignal returns a capture link object (`id`, `token`, `url`, `expiresAt`). 4. Actor stores that result in dataset output. 5. You share `captureLink.url` with your user. 6. After user completes capture, VideoSignal sends media details to your webhook. ### Required Input - `apiKey`: VideoSignal API key with `capture:create` scope - `webhookUrl`: HTTPS endpoint that receives upload completion events ### Optional Input - `webhookSecret`: Secret used to sign webhook payloads (recommended) - `expiresInHours`: Link validity duration (default: 168) - `linkSettings`: Capture constraints (duration, file size, allowed types, etc.) - `metadata`: Custom key-value data returned in webhook payloads - `apiBaseUrl`: Override API host if needed ### Output Example ```json { "success": true, "captureLink": { "id": "cl_123", "token": "tok_abc", "url": "https://app.videosignal.io/c/tok_abc", "expiresAt": "2026-03-05T12:00:00.000Z" }, "webhookUrl": "https://example.com/webhooks/videosignal", "message": "Capture link created successfully. Videos will be delivered via webhook." } ```` ### Webhook Delivery When capture is completed, VideoSignal sends an event to your `webhookUrl` with media metadata and download links. Recommended: - Verify webhook signatures when `webhookSecret` is configured. - Store `captureLink.id` and your `metadata` values to map uploads back to users/workflows. # Actor input Schema ## `apiKey` (type: `string`): VideoSignal API key with 'capture:create' scope. Format: vsk\_live\_xxxxx or vsk\_test\_xxxxx ## `webhookUrl` (type: `string`): URL to receive video upload notifications when users complete their recording ## `apiBaseUrl` (type: `string`): VideoSignal API endpoint (optional, defaults to production) ## `webhookSecret` (type: `string`): HMAC secret for webhook signature verification (minimum 32 characters). If provided, VideoSignal will sign webhook payloads. ## `expiresInHours` (type: `integer`): How long the capture link remains valid ## `linkSettings` (type: `object`): Video/image capture constraints as JSON. Example: {"maxDurationSeconds": 300, "maxFileSizeMb": 100, "allowedTypes": \["video"], "allowMultipleCaptures": false} ## `metadata` (type: `object`): Custom key-value pairs to include in webhook payload. Example: {"userId": "123", "campaign": "onboarding"} ## Actor input object example ```json { "apiBaseUrl": "https://developer.videosignal.ai", "expiresInHours": 168 } ``` # Actor output Schema ## `captureLinkResults` (type: `string`): Dataset containing the capture link URL, token, and webhook details # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("vs.ai/videosignal").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("vs.ai/videosignal").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call vs.ai/videosignal --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=vs.ai/videosignal", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Videosignal", "description": "VideoSignal lets you collect videos or images from end users through a browser capture page, then notifies your backend when uploads are complete.\n\nWhat This Actor Does\nThis actor creates a new VideoSignal capture link by calling the VideoSignal API and writes the link details to the Actor dataset.", "version": "1.0", "x-build-id": "bTueaYyqGRtV1jnXJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vs.ai~videosignal/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vs.ai-videosignal", "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/vs.ai~videosignal/runs": { "post": { "operationId": "runs-sync-vs.ai-videosignal", "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/vs.ai~videosignal/run-sync": { "post": { "operationId": "run-sync-vs.ai-videosignal", "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": [ "apiKey", "webhookUrl" ], "properties": { "apiKey": { "title": "API Key", "type": "string", "description": "VideoSignal API key with 'capture:create' scope. Format: vsk_live_xxxxx or vsk_test_xxxxx" }, "webhookUrl": { "title": "Webhook URL", "pattern": "^https?://.+", "type": "string", "description": "URL to receive video upload notifications when users complete their recording" }, "apiBaseUrl": { "title": "API Base URL", "type": "string", "description": "VideoSignal API endpoint (optional, defaults to production)", "default": "https://developer.videosignal.ai" }, "webhookSecret": { "title": "Webhook Secret", "type": "string", "description": "HMAC secret for webhook signature verification (minimum 32 characters). If provided, VideoSignal will sign webhook payloads." }, "expiresInHours": { "title": "Link Expiration (hours)", "minimum": 1, "maximum": 8760, "type": "integer", "description": "How long the capture link remains valid", "default": 168 }, "linkSettings": { "title": "Link Settings", "type": "object", "description": "Video/image capture constraints as JSON. Example: {\"maxDurationSeconds\": 300, \"maxFileSizeMb\": 100, \"allowedTypes\": [\"video\"], \"allowMultipleCaptures\": false}" }, "metadata": { "title": "Metadata", "type": "object", "description": "Custom key-value pairs to include in webhook payload. Example: {\"userId\": \"123\", \"campaign\": \"onboarding\"}" } } }, "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 } } } } } } } } } } ```