apify/agent-skills

"email": "support@apify.com"   },   "homepage": "https://github.com/apify/agent-skills",

},   "homepage": "https://github.com/apify/agent-skills",   "repository": "https://github.com/apify/agent-skills",

"homepage": "https://github.com/apify/agent-skills",

"repository": "https://github.com/apify/agent-skills",

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

Pricing is set in Apify Console when the Actor is published, not in code. Under pay-per-event, charge each custom event with `await Actor.charge({ eventName: 'result', count })` in JS/TS or `await Actor.charge(event_name='result', count=cou

apify actors info <actor> --readme --user-agent apify-agent-skills/apify-actor-development apify actors info <actor> --input --user-agent apify-agent-skills/apify-actor-development apify call <actor> --input '{"startUrls":[{"url":"https://e

apify actors info <actor> --input --user-agent apify-agent-skills/apify-actor-development apify call <actor> --input '{"startUrls":[{"url":"https://example.com"}]}' --user-agent apify-agent-skills/apify-actor-development apify call <actor> 

apify call <actor> --input '{"startUrls":[{"url":"https://example.com"}]}' --user-agent apify-agent-skills/apify-actor-development

- With the Apify MCP server (`https://mcp.apify.com/?tools=docs`): `search-apify-docs` and `fetch-apify-docs`.

- [docs.apify.com/llms.txt](https://docs.apify.com/llms.txt) and [llms-full.txt](https://docs.apify.com/llms-full.txt), Apify platform.

- [crawlee.dev/llms.txt](https://crawlee.dev/llms.txt) and [llms-full.txt](https://crawlee.dev/llms-full.txt), Crawlee.

- [Actor whitepaper](https://raw.githubusercontent.com/apify/actor-whitepaper/refs/heads/master/README.md), the full Actor specification.

- [Instagram Scraper](https://apify.com/apify/instagram-scraper)

- [Google Maps Scraper](https://apify.com/compass/crawler-google-places)

- Use emojis sparingly as bullet points to break up text - Keep images compressed but good quality - Use [Carbon](https://github.com/carbon-app/carbon) for code snippet screenshots if needed

- Use [Carbon](https://github.com/carbon-app/carbon) for code snippet screenshots if needed

`.actor/input_schema.json` drives both validation and the Console form. The platform validates input against it before the Actor starts, so a field the code reads but the schema omits fails silently for users of the form. Full specification

"description": "Category or product pages to start from",             "editor": "requestListSources",             "prefill": [{ "url": "https://example.com/category" }]

"editor": "requestListSources",             "prefill": [{ "url": "https://example.com/category" }]         },

"prefill": [{ "url": "https://example.com/category" }]

"actorSpecification": 1,     "fields": {         "$schema": "http://json-schema.org/draft-07/schema#",

"fields": {         "$schema": "http://json-schema.org/draft-07/schema#",         "type": "object",

"$schema": "http://json-schema.org/draft-07/schema#",

"example": { "name": "Example Author", "url": "https://example.com/author" }

1. Start `apify run` in the background and retry the probe below until it answers. 2. Probe readiness: `curl -H "x-apify-container-server-readiness-probe: true" http://localhost:4321/` returns HTTP 200.

2. Probe readiness: `curl -H "x-apify-container-server-readiness-probe: true" http://localhost:4321/` returns HTTP 200.

3. Call each endpoint with curl or httpie and check the responses.

- [Developing Actors using Standby mode](https://docs.apify.com/platform/actors/development/programming-interface/standby#developing-actors-using-standby-mode)

- [Running Actors in Standby mode](https://docs.apify.com/platform/actors/running/standby)

> **Security note:** Do NOT install the CLI by piping remote scripts to a shell > (e.g. `curl ... | bash` or `irm ... | iex`). Always use a package manager.

> (e.g. `curl ... | bash` or `irm ... | iex`). Always use a package manager.

> (e.g. `curl ... | bash` or `irm ... | iex`). Always use a package manager.

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

- [Instagram Scraper](https://apify.com/apify/instagram-scraper)

- [Google Maps Scraper](https://apify.com/compass/crawler-google-places)

apify run --input '{"startUrl": "https://example.com", "maxItems": 10}' --user-agent apify-agent-skills/apify-actorization

- **Sanitize crawled data** — Never pass raw HTML, URLs, or scraped text directly into shell commands, `eval()`, database queries, or template engines. Use proper escaping or parameterized APIs.

Otherwise, the MCP Server url: `https://mcp.apify.com/?tools=docs`.

- [Actorization Academy](https://docs.apify.com/academy/actorization) - Comprehensive guide

- [Apify SDK for JavaScript](https://docs.apify.com/sdk/js) - Full SDK reference

- [Apify SDK for Python](https://docs.apify.com/sdk/python) - Full SDK reference

- [Apify CLI Reference](https://docs.apify.com/cli) - CLI commands

- [Actor Specification](https://raw.githubusercontent.com/apify/actor-whitepaper/refs/heads/master/README.md) - Complete specification

Reference the [cli-start template Dockerfile](https://github.com/apify/actor-templates/blob/master/templates/cli-start/Dockerfile) which includes the `ubi` utility for installing binaries from GitHub releases.

# Install ubi for easy GitHub release installation RUN curl --silent --location \

RUN curl --silent --location      https://raw.githubusercontent.com/houseabsolute/ubi/master/bootstrap/bootstrap-ubi.sh | sh

RUN curl --silent --location \

https://raw.githubusercontent.com/houseabsolute/ubi/master/bootstrap/bootstrap-ubi.sh | sh

const input = await Actor.getInput(); const {     startUrl = 'https://example.com',

const {     startUrl = 'https://example.com',     maxItems = 100,

startUrl = 'https://example.com',

# Get and validate input         actor_input = await Actor.get_input() or {}         start_url = actor_input.get('startUrl', 'https://example.com')

actor_input = await Actor.get_input() or {}         start_url = actor_input.get('startUrl', 'https://example.com')         max_items = actor_input.get('maxItems', 100)

start_url = actor_input.get('startUrl', 'https://example.com')

"description": "The URL to start processing from",             "editor": "textfield",             "prefill": "https://example.com"

"editor": "textfield",             "prefill": "https://example.com"         },

"prefill": "https://example.com"

// Get the public URL const storeInfo = await Actor.openKeyValueStore(); const publicUrl = `https://api.apify.com/v2/key-value-stores/${storeInfo.id}/records/report.pdf`;

const publicUrl = `https://api.apify.com/v2/key-value-stores/${storeInfo.id}/records/report.pdf`;

// Add tasks to the queue (works for any processing, not just URLs) await requestQueue.addRequest({     url: 'https://placeholder.local',  // Dummy URL for non-scraping tasks

await requestQueue.addRequest({     url: 'https://placeholder.local',  // Dummy URL for non-scraping tasks     uniqueKey: `task-${taskId}`,       // Unique identifier for deduplication

url: 'https://placeholder.local',  // Dummy URL for non-scraping tasks

- If the `apify-actor-development` skill is available, load it and follow its `references/output-schemas.md`. - If it is not available, tell the user this skill is deprecated and help them install `apify-actor-development` from `https://git

- If it is not available, tell the user this skill is deprecated and help them install `apify-actor-development` from `https://github.com/apify/agent-skills`, then stop. Do not write the schemas from memory. Use the install method that fits

- Claude Code plugin: `/plugin install apify-actor-development@apify-agent-skills`   - Skills CLI, which works with most agents: `npx skills add https://github.com/apify/agent-skills --skill apify-actor-development`   - Cloned repo: pull th

- Skills CLI, which works with most agents: `npx skills add https://github.com/apify/agent-skills --skill apify-actor-development`

Before designing anything, fetch and read `https://apify.com/agents.md`. It is the canonical quickstart for AI agents and the single source of truth for vocabulary, the run flow, and the cost rule. If the fetch fails, the mini-glossary belo

- **Key-Value Store** - unstructured/file storage (screenshots, HTML, OUTPUT). - **Actor Task** - a saved, parameterized configuration for running an Actor. - **Apify Store** - the marketplace of Actors at `https://apify.com/store.md`.

- **Actor Task** - a saved, parameterized configuration for running an Actor. - **Apify Store** - the marketplace of Actors at `https://apify.com/store.md`. - **Apify Console** - the web UI at `https://console.apify.com`.

- **Apify Store** - the marketplace of Actors at `https://apify.com/store.md`.

- **Apify Console** - the web UI at `https://console.apify.com`.

Further terms (build, request queue, proxy, pricing models): `https://docs.apify.com/llms.txt`.

The Apify MCP server is the fastest way to research Actors, schemas, pricing, and docs during integration design. See `https://docs.apify.com/integrations/mcp` (append `.md` for a markdown version).

### Cost is first-class Every path that starts a run must expose a cost control. The canonical control is `maxTotalChargeUsd` (caps the run's total charge on most pricing models) and `maxItems` (caps billed items on pay-per-result Actors). 

Every path that starts a run must expose a cost control. The canonical control is `maxTotalChargeUsd` (caps the run's total charge on most pricing models) and `maxItems` (caps billed items on pay-per-result Actors). Send them as **options /

### Centralized HTTP layer One base-URL constant, shared between credentials and the HTTP layer. A Server Actor lives on its own host (`https://web-fetch.apify.actor`) - route it through the same layer so auth and attribution headers still 

One base-URL constant, shared between credentials and the HTTP layer. A Server Actor lives on its own host (`https://web-fetch.apify.actor`) - route it through the same layer so auth and attribution headers still apply. Retries with exponen

### Generate from OpenAPI where the host allows it If the host platform can generate UI fields from an OpenAPI spec, use Apify's spec (`https://apify.com/openapi.json`) and a tag allowlist. Hand-write only what the spec cannot express: conv

If the host platform can generate UI fields from an OpenAPI spec, use Apify's spec (`https://apify.com/openapi.json`) and a tag allowlist. Hand-write only what the spec cannot express: convenience wrappers, bill-cap fields, lean AI-tool out

### High-level convenience operations alongside generic runs Generic "run Actor" serves power users. Add a few opinionated, high-level actions for the common case so non-power users get a 2-field form instead of a full Actor configuration. 

Generic "run Actor" serves power users. Add a few opinionated, high-level actions for the common case so non-power users get a 2-field form instead of a full Actor configuration. The canonical one is **Web Fetch**: one URL in, page content 

| Webhook CRUD | `POST/GET/DELETE /v2/webhooks` | | Validate token / current user | `GET /v2/users/me` | | Fetch one URL (Web Fetch, Server Actor) | `POST https://web-fetch.apify.actor/` |

| Fetch one URL (Web Fetch, Server Actor) | `POST https://web-fetch.apify.actor/` |

REST reference: `https://docs.apify.com/api/v2`. OpenAPI spec: `https://apify.com/openapi.json`.

1. Fetch `https://apify.com/agents.md` and internalize the model.

[Credential-related source omitted]

The README's top banner should direct users to Apify's MCP server (`https://mcp.apify.com`) as a richer, more featureful alternative for interactive agent workflows that need dynamic Actor discovery. The package is not deprecated, but the M

- **Approach A - Coding agent plugin (skills + MCP bundle):** for skills/MCP-aware coding assistants like Cursor, Claude Code, Codex, and GitHub Copilot. You assemble a small set of runtime artifacts the host already knows how to load, and 

| Artifact | Role at runtime | |---|---| | **MCP server** | Registers `https://mcp.apify.com` with the host and exposes the callable tool surface (below). OAuth: the user signs in via browser on the first tool call that needs auth - no toke

|---|---| | **MCP server** | Registers `https://mcp.apify.com` with the host and exposes the callable tool surface (below). OAuth: the user signs in via browser on the first tool call that needs auth - no token in config. | | **Skills** | O

| **MCP server** | Registers `https://mcp.apify.com` with the host and exposes the callable tool surface (below). OAuth: the user signs in via browser on the first tool call that needs auth - no token in config. |

- [ ] MCP declared and reachable - `https://mcp.apify.com` registered and its tools appear in the tool list. - [ ] OAuth works - the first auth-requiring MCP call prompts a browser sign-in; no token in config. - [ ] Skills load by intent - 

[Credential-related source omitted]

[Credential-related source omitted]

- The key is **never** included in tool output, **never** logged, only passed to the client constructor. - Validate `baseUrl` against an allowlist prefix (`https://api.apify.com`, plus `https://web-fetch.apify.actor` if the plugin ships a W

- Validate `baseUrl` against an allowlist prefix (`https://api.apify.com`, plus `https://web-fetch.apify.actor` if the plugin ships a Web Fetch tool) to prevent SSRF - a misconfigured plugin must not point at an arbitrary host.

Use the official `apify-client` SDK (JS or Python), not raw HTTP. The exception is a Server Actor call such as Web Fetch (see `SKILL.md`), which is a plain HTTPS request - stamp the same headers on it by hand. Construct the client once, mem

Get an `APIFY_TOKEN` from **Console > Settings > Integrations** at `https://console.apify.com/settings/integrations`. Account sign-up: `https://console.apify.com/sign-up` (free, no credit card). Store the token in an environment variable or

Alternatively, browse `https://apify.com/store`. Append `.md` to any Actor's Store URL to get its docs in markdown (e.g. `https://apify.com/apify/web-scraper.md`). Build input from the schema rather than guessing field names.

[Credential-related source omitted]

const run = await client.actor('apify/web-scraper').call({     startUrls: [{ url: 'https://example.com' }],

startUrls: [{ url: 'https://example.com' }],

const run = await client.actor('apify/web-scraper').start({     startUrls: [{ url: 'https://example.com' }],

startUrls: [{ url: 'https://example.com' }],

[Credential-related source omitted]

run = client.actor('apify/web-scraper').call(     run_input={         'startUrls': [{'url': 'https://example.com'}],

run_input={         'startUrls': [{'url': 'https://example.com'}],         'maxPagesPerCrawl': 10,

'startUrls': [{'url': 'https://example.com'}],

run = client.actor('apify/web-scraper').start(run_input={     'startUrls': [{'url': 'https://example.com'}],

'startUrls': [{'url': 'https://example.com'}],

[Credential-related source omitted]

run = await client.actor('apify/web-scraper').call(run_input={     'startUrls': [{'url': 'https://example.com'}],

'startUrls': [{'url': 'https://example.com'}],

POST https://api.apify.com/v2/actors/{actorId}/runs

{ "startUrls": [{ "url": "https://example.com" }] }

GET https://api.apify.com/v2/actor-runs/{runId}

GET https://api.apify.com/v2/datasets/{datasetId}/items?format=json

POST https://api.apify.com/v2/actors/{username}~{actor-name}/run-sync-get-dataset-items

REST reference: `https://docs.apify.com/api/v2`. OpenAPI spec: `https://apify.com/openapi.json`.

- API client for JS: `https://docs.apify.com/api/client/js`

- API client for Python: `https://docs.apify.com/api/client/python`

- REST API reference: `https://docs.apify.com/api/v2`

- Apify docs (LLM-friendly): `https://docs.apify.com/llms.txt`

- Apify docs (full): `https://docs.apify.com/llms-full.txt`

IDs (Actor, Task, run, dataset, KV store, record key) should use the host's resource-locator property type with multiple modes: **From list**, **By URL**, **By ID**. Extract the ID from a pasted Console URL (e.g. `https://console.apify.com/

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

Report: result count, file location (if saved), key data fields, and links: - Dataset: `https://console.apify.com/storage/datasets/DATASET_ID`

- Dataset: `https://console.apify.com/storage/datasets/DATASET_ID`

- Run: `https://console.apify.com/actors/runs/RUN_ID`

| Symptom | Likely cause | Fix | |---------|-------------|-----| | `status: FAILED` in run output | Actor crashed or input invalid | Read `.statusMessage` in JSON; check run log at `https://console.apify.com/actors/runs/RUN_ID/log` |

|---------|-------------|-----| | `status: FAILED` in run output | Actor crashed or input invalid | Read `.statusMessage` in JSON; check run log at `https://console.apify.com/actors/runs/RUN_ID/log` | | `isDeprecated: true` in Actor info | 

| `status: FAILED` in run output | Actor crashed or input invalid | Read `.statusMessage` in JSON; check run log at `https://console.apify.com/actors/runs/RUN_ID/log` |