{ "openapi": "3.0.1", "info": { "title": "PeerTube Instance Harvester", "description": "Point at any PeerTube instance and export its videos, channels and instance metadata from the public /api/v1 REST API. Federated, self-hosted YouTube alternative — one actor over thousands of instances.", "version": "0.1", "x-build-id": "zBPQGdas3eROsVZfK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~peertube-instance-harvester/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-peertube-instance-harvester", "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/datamule~peertube-instance-harvester/runs": { "post": { "operationId": "runs-sync-datamule-peertube-instance-harvester", "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/datamule~peertube-instance-harvester/run-sync": { "post": { "operationId": "run-sync-datamule-peertube-instance-harvester", "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": [ "instanceUrl" ], "properties": { "instanceUrl": { "title": "PeerTube instance URL", "type": "string", "description": "Root URL of ANY PeerTube instance. PeerTube is the ActivityPub-federated, self-hosted YouTube alternative; every instance exposes the identical public /api/v1 REST API with no auth for public content, so one actor works against all of them: https://framatube.org, https://makertube.net, https://tube.tchncs.de, or any of the thousands of self-hosted instances. The /api/v1 path is appended for you (paste either the root or a /api/v1 URL). The run MODE is chosen from the 'mode' / 'listOnly' / 'search' fields below." }, "mode": { "title": "Mode", "enum": [ "videos", "channels", "discovery" ], "type": "string", "description": "What to harvest. 'videos' (default) lists videos via /api/v1/videos (or /api/v1/search/videos when a search term is set). 'channels' lists the instance's video channels via /api/v1/video-channels. 'discovery' returns ONE row describing the instance (name, version, signup policy, short description, total video count) so you can inspect an instance cheaply before a full run.", "default": "videos" }, "search": { "title": "Search query (videos mode)", "type": "string", "description": "VIDEOS MODE. A free-text search term — switches the run to GET /api/v1/search/videos?search=... and returns one row per matching video across the instance's federated index. Leave empty to list the instance's full video timeline (newest first). A term that matches nothing yields 0 records and a clean exit." }, "sort": { "title": "Sort (videos mode)", "type": "string", "description": "VIDEOS MODE. Sort order for the video listing. Defaults to -publishedAt (newest first). PeerTube commonly accepts: -publishedAt, publishedAt, -views, views, -likes, -trending, -hot, name, -duration. Left as free text so any instance's accepted value passes through.", "default": "-publishedAt" }, "includeNsfw": { "title": "Include NSFW videos (videos mode)", "type": "boolean", "description": "VIDEOS MODE. When false (default) NSFW videos are excluded (nsfw=false). Set true to include them (nsfw=both).", "default": false }, "listOnly": { "title": "Discovery only (instance info)", "type": "boolean", "description": "Shortcut for discovery mode: when true, ignore 'mode' and emit ONLY the single instance-info row (name, version, signup, total video count). A cheap way to probe an instance before harvesting it.", "default": false }, "maxRecords": { "title": "Max records (global cap)", "minimum": 1, "type": "integer", "description": "A GLOBAL cap on the number of rows to emit. The rendered default is 25, so a first run emits at most 25 rows. Each emitted video, channel, or discovery row is one billable `video` event under the current pricing contract. Pagination stops as soon as the cap is reached, so the default is a cheap, deterministic sample. Raise the value explicitly to fetch more matching rows.", "default": 25 }, "bearer": { "title": "Bearer token", "type": "string", "description": "Optional access token for a private / registration-required / rate-limited instance (sent as Authorization: Bearer ***). Not required for public content. Never logged." }, "extraHeaders": { "title": "Extra request headers", "type": "object", "description": "Optional extra HTTP headers as a JSON object, e.g. {\"x-api-key\": \"...\"} for gated instances. Not required for public content. Header values are never logged." } } }, "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 } } } } } } } } } }