Actor Router API

Run endpoints are protected by a gateway API key. Directory and schema discovery endpoints are public. Use it like an OpenRouter-style gateway for long-running Apify Actors: discover, inspect input, start a run, poll, fetch normalized results.

Discover

GET /v1
GET /v1/capabilities
GET /v1/actors?capability=social_profile_extraction&limit=20
GET /v1/models
GET /v1/schemas
GET /v1/actors/compass~crawler-google-places/schema
GET /v1/account/usage   # protected; Apify usage and limits

Unified run endpoint

POST /v1/runs
Authorization: Bearer <gateway_api_key>
Content-Type: application/json

{
  "actor": "compass/crawler-google-places",
  "input": { "searchString": "coffee near Austin", "maxCrawledPlaces": 1 },
  "max_total_charge_usd": 0.5,
  "wait_for_finish": 0
}

Dry run before spending

POST /v1/runs
Authorization: Bearer <gateway_api_key>
Content-Type: application/json

{
  "actor": "compass/crawler-google-places",
  "input": { "searchString": "coffee near Austin", "maxCrawledPlaces": 1 },
  "max_total_charge_usd": 0.5,
  "dry_run": true
}

Run a capability with fallback

POST /v1/capabilities/social_profile_extraction/runs
Authorization: Bearer <gateway_api_key>
Content-Type: application/json

{
  "input": { "username": "openai", "maxItems": 25 },
  "max_total_charge_usd": 1,
  "wait_for_finish": 0
}

Poll and retrieve

GET /v1/runs/{run_id}
GET /v1/runs/{run_id}/result?limit=100

# Backward-compatible aliases:
GET /v1/jobs/{run_id}
GET /v1/jobs/{run_id}/result?limit=100