# test (`piercing_runner/input-orchestrator`) Actor

Test

- **URL**: https://apify.com/piercing\_runner/input-orchestrator.md
- **Developed by:** [Big Soup](https://apify.com/piercing_runner) (community)
- **Categories:** Automation
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 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

## actor: input-orchestrator

Single entry point for on-demand scrape batches. Post-pivot 4-case dispatch matrix `(capacity × webhook)`:

| payload vs cap | no webhook | webhook |
|---|---|---|
| fits     | sync (poll, return results) | async (exit, deliverer fires later) |
| overflow | **FAIL** `no_capacity`      | accept (overflow queued for dispatcher), exit |

- **Input:** `{ target_app, payload[], webhook?, secret?, metadata? }` — see `.actor/input_schema.json`
- **Output:** Apify dataset entry — sync `{ batch_id, status, total, completed, failed, results[] }` or async `{ batch_id, status: 'accepted', today, deferred }`
- **DB writes:** INSERT `batches` (encrypts `webhook_secret_enc` if `secret` provided) + RPC `claim_scrape_slots` (atomic + advisory locked)
- **Spawn fan-out:** today-zone claims → 1 `scrape-data` actor per worker (with up to 5 jobs in `jobs[]`)
- **Defer model:** the `deferred` zone stores rows with `worker_id IS NULL` and `queued_at=now`; the `dispatcher` Edge Fn picks them up FIFO later (reactive on worker availability + hourly cron fallback)
- **Webhook off-ramp:** PG trigger on `batches.status='webhook_pending'` → `/apify-webhook` event `batch.completed` → spawns `webhook-deliverer`
- **Validation:** payload 1..1000 items × 1..255 chars; webhook HTTPS + SSRF reject; `secret` only valid when `webhook` set; metadata max 2048 chars
- **Sync timeout:** 15 min hard cap → batch flagged `partial_timeout`, partial results returned

See `/Users/romanjanek/sm/ztest/memory.md` for full system context.

# Actor input Schema

## `target_app` (type: `string`):

Which target app to scrape. Currently supported: 'youtube'. Must be a supported value (others are rejected). [1..64 chars, [a-z0-9_-]+]
## `payload` (type: `array`):

Array of YouTube channel targets — each a '@handle' or any URL containing one (e.g. '@SomeChannel' or 'https://youtube.com/@SomeChannel'). Each is normalized to '@handle' (URL prefix stripped) and duplicates are removed. Targets with no extractable @handle (e.g. channel/UC… or c/… URLs) are dropped. 1..1000 items, each 1..255 chars, no control chars.
## `webhook` (type: `string`):

HTTPS URL to POST batch result to on completion. REQUIRES `secret` to be set in the same call. If absent + payload > today_capacity → FAIL no_capacity. If present, overflow is queued for dispatcher pick-up later.
## `secret` (type: `string`):

Symmetric key used to ENCRYPT the result payload we POST to your webhook, so only you can read it. We POST JSON { batch_id, encryption: 'aes-256-gcm', payload } where payload = base64([version:1=0x01][iv:12][ciphertext+GCM-tag]). To decrypt: key = SHA-256(utf8(secret)) (32-byte AES-256 key); base64-decode payload; iv = bytes[1..13]; ciphertext = bytes[13..]; AES-256-GCM decrypt with no AAD → the result JSON. Required whenever `webhook` is set; rejected if `webhook` is absent. 16..256 chars.
## `metadata` (type: `string`):

Opaque string forwarded into webhook payload. Max 2048 chars.
## `partner` (type: `string`):

ID of partner lvl customer
## `client_key` (type: `string`):

If the operator set ORCHESTRATOR_API_KEYS, this must match one of them or the run is rejected ('unauthorized'). Leave empty when app-level client auth is off.

## Actor input object example

```json
{}
````

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("piercing_runner/input-orchestrator").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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("piercing_runner/input-orchestrator").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 piercing_runner/input-orchestrator --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=piercing_runner/input-orchestrator",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "test",
        "description": "Test",
        "version": "0.0",
        "x-build-id": "UKVGboIZEiNPcYOhR"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/piercing_runner~input-orchestrator/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-piercing_runner-input-orchestrator",
                "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/piercing_runner~input-orchestrator/runs": {
            "post": {
                "operationId": "runs-sync-piercing_runner-input-orchestrator",
                "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/piercing_runner~input-orchestrator/run-sync": {
            "post": {
                "operationId": "run-sync-piercing_runner-input-orchestrator",
                "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": [
                    "target_app",
                    "payload"
                ],
                "properties": {
                    "target_app": {
                        "title": "Target app",
                        "type": "string",
                        "description": "Which target app to scrape. Currently supported: 'youtube'. Must be a supported value (others are rejected). [1..64 chars, [a-z0-9_-]+]"
                    },
                    "payload": {
                        "title": "Scrape targets",
                        "type": "array",
                        "description": "Array of YouTube channel targets — each a '@handle' or any URL containing one (e.g. '@SomeChannel' or 'https://youtube.com/@SomeChannel'). Each is normalized to '@handle' (URL prefix stripped) and duplicates are removed. Targets with no extractable @handle (e.g. channel/UC… or c/… URLs) are dropped. 1..1000 items, each 1..255 chars, no control chars.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "webhook": {
                        "title": "Webhook URL (optional, paired with secret)",
                        "type": "string",
                        "description": "HTTPS URL to POST batch result to on completion. REQUIRES `secret` to be set in the same call. If absent + payload > today_capacity → FAIL no_capacity. If present, overflow is queued for dispatcher pick-up later."
                    },
                    "secret": {
                        "title": "Webhook encryption secret (required if webhook is set)",
                        "type": "string",
                        "description": "Symmetric key used to ENCRYPT the result payload we POST to your webhook, so only you can read it. We POST JSON { batch_id, encryption: 'aes-256-gcm', payload } where payload = base64([version:1=0x01][iv:12][ciphertext+GCM-tag]). To decrypt: key = SHA-256(utf8(secret)) (32-byte AES-256 key); base64-decode payload; iv = bytes[1..13]; ciphertext = bytes[13..]; AES-256-GCM decrypt with no AAD → the result JSON. Required whenever `webhook` is set; rejected if `webhook` is absent. 16..256 chars."
                    },
                    "metadata": {
                        "title": "Metadata pass-through (optional)",
                        "type": "string",
                        "description": "Opaque string forwarded into webhook payload. Max 2048 chars."
                    },
                    "partner": {
                        "title": "Partner ID",
                        "type": "string",
                        "description": "ID of partner lvl customer"
                    },
                    "client_key": {
                        "title": "Client API key (optional)",
                        "type": "string",
                        "description": "If the operator set ORCHESTRATOR_API_KEYS, this must match one of them or the run is rejected ('unauthorized'). Leave empty when app-level client auth is off."
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```