At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key comes from
APIFY_TOKEN. - Docs: https://docs.apify.com/api/v2#authentication
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
APIFY_TOKEN | Yes | Apify API token (starts with apify_api_) Docs. |
Setup
- Create an Apify account: Sign up at https://console.apify.com - the free plan includes monthly platform credits, enough for testing small actor runs.
- Copy your API token: In the Apify Console go to Settings → API & Integrations (https://console.apify.com/settings/integrations) and copy your personal API token (apify_api_…).
- Store the token: Add it to your .env file as APIFY_TOKEN=apify_api_…
- Verify access: Run the List Actors tool. To run a store actor you have not used before, reference it as username
actorname (e.g. apifyweb-scraper) - each actor’s input schema is on its store page.
- Actor runs consume platform credits based on compute, memory, and storage - check the actor’s pricing on the Apify Store
- Run Actor (Sync) waits up to 300 seconds; for longer scrapes start the run asynchronously in the Apify Console and fetch results with Get Dataset Items
- Responses are wrapped in a ‘data’ property; dataset item responses are plain arrays
Tools
| Tool | Access | Description |
|---|---|---|
| List Actors | Read | List actors in your Apify account |
| Run Actor (Sync) | Write | Run an actor, wait for it to finish (up to 300s), and return its dataset items (consumes platform credits) |
| Get Run | Read | Get the status and details of an actor run, including its defaultDatasetId |
| List Runs | Read | List recent actor runs in your account |
| Get Dataset Items | Read | Fetch items from a dataset produced by an actor run |
Example prompts
- Run an Apify actor to scrape a website I specify and summarize the extracted data.
- List my recent Apify actor runs with their statuses and fetch the dataset items of the latest successful one.