automation
Apify MCP, CLI, and Lua Integration for AI Agents
Apify integration docs for AI agents: MCP gateway setup, Apify CLI commands, Lua API reference, credentials, and function schemas.
10 functions 9 read 1 write API token auth
Apify for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
apify- route_slug
apify- package
apify- auth_strategy
api_tokenAPI token- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. Apify CLIHeadless setup and direct function calls. Apify MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
Apify MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for Apify.
Claude Code Apify MCP setup for Claude Code. Cursor Apify MCP setup for Cursor. Codex Apify MCP setup for Codex. OpenAI Agents Apify MCP setup for OpenAI Agents SDK. Claude Agent SDK Apify MCP setup for Claude Agent SDK. Vercel AI SDK Apify MCP setup for Vercel AI SDK. LangChain Apify MCP setup for LangChain. LangGraph Apify MCP setup for LangGraph. CrewAI Apify MCP setup for CrewAI. MCP clients Apify MCP setup for Generic MCP Clients.
Apify CLI Matrix
Use these pages for direct Apify CLI workflows in scripts, CI, cron, and agent wrappers.
CI Apify CLI for CI. Cron Jobs Apify CLI for cron jobs. Shell Scripts Apify CLI for shell scripts. Headless Automation Apify CLI for headless automation. Coding Agents Apify CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
apify.apify_run_actor | Write write | 6 | Run an Apify actor. Provide the actor ID and input configuration to start a new run. Returns the run details including run ID and status. Use apify_get_run to check progress. |
apify.apify_get_run | Read read | 1 | Get details and status of an Apify actor run. Returns the run status (READY, RUNNING, SUCCEEDED, FAILED, ABORTED, TIMING-OUT, TIMED-OUT), output dataset ID, and other metadata. |
apify.apify_list_actors | Read read | 2 | List Apify actors available to the authenticated user. Returns actor names, IDs, descriptions, and versions. Supports pagination with offset and limit. |
apify.apify_get_actor | Read read | 1 | Get details of a specific Apify actor, including its description, input schema, default run options, and available versions. Use this to understand what input an actor requires before running it. |
apify.apify_list_datasets | Read read | 2 | List Apify datasets accessible to the authenticated user. Returns dataset IDs, names, item counts, and sizes. Supports pagination. |
apify.apify_get_dataset | Read read | 1 | Get details of a specific Apify dataset, including its item count, size, name, and associated actor run. Use apify_get_dataset_items to retrieve the actual data. |
apify.apify_get_dataset_items | Read read | 4 | Retrieve items from an Apify dataset. Supports JSON, CSV, and other formats. Use this to get the results from completed actor runs. Datasets are referenced by ID from run results. |
apify.apify_list_key_value_stores | Read read | 2 | List Apify key-value stores accessible to the authenticated user. Key-value stores hold actor outputs like screenshots, PDFs, or JSON results. Supports pagination. |
apify.apify_get_record | Read read | 2 | Get a record from an Apify key-value store by its key. Common keys include "OUTPUT" for actor results, "SCREENSHOT" for page screenshots, or custom keys set by actor runs. |
apify.apify_get_current_user | Read read | 0 | Get the profile of the currently authenticated Apify user. Returns user ID, username, email, plan details, and monthly usage information. |