Apify integration

Aborts a running Actor execution immediately. Run status changes to ABORTED. Partial results may be available in the dataset. Resources are released.

Retrieves current status and details of an Actor run. Returns status (READY, RUNNING, SUCCEEDED, FAILED, etc.), timing info, and dataset/store IDs. Poll periodically to monitor async runs.

Resurrects a finished Actor run, restarting its container with the same storages. Only works for runs with terminal status (SUCCEEDED, FAILED, ABORTED, TIMED-OUT). Run status changes to RUNNING.

Runs an Actor (web scraper or automation) with provided input. Actor ID can be your own or a public one like 'apify/web-scraper'. Input is passed in request body. Returns run object with ID for monitoring. Use waitForFinish for short runs.

Runs an Actor synchronously and returns results immediately when complete. Connection held up to 5 minutes. Returns dataset items directly instead of run object. Best for quick extractions.

Runs an Actor task using its saved configuration. Optionally override input by passing JSON body. Override timeout, memory, or build with query params. Returns run object.

Creates a new Actor on the Apify platform. Define name, description, source type, and default run options. Returns the created Actor object with ID.

Permanently deletes an Actor and all its versions and builds. This action cannot be undone. Associated runs, datasets, and stores are NOT deleted.

Retrieves detailed information about an Actor. Returns description, input schema, default run options, versions, and usage stats. Essential for understanding Actor capabilities before running.

Updates an existing Actor's settings. Modify name, description, default run options, visibility, or version configuration. Returns the updated Actor object.

Creates a schedule for automatic recurring Actor runs. Define timing with cron expression, specify Actor/task to run, and configure input. Schedule runs automatically at specified times.

Permanently deletes a schedule. Scheduled runs will no longer execute. Past runs and their data are NOT affected. Returns 204 No Content.

Retrieves details of a specific schedule. Returns name, cron expression, timezone, actions, enabled status, and next run time. Use to inspect schedule configuration.

Updates a schedule's configuration. Modify cron expression, actions, timezone, or enable/disable. Only provided fields are updated. Returns updated schedule object.

Creates a named dataset for storing structured data. If a dataset with the given name already exists, returns the existing one. Named datasets persist until explicitly deleted.

Permanently deletes a dataset and all its stored items. This action cannot be undone. Returns 204 No Content on success.

Retrieves metadata about a dataset. Returns item count, creation date, size, and access info. Use to check dataset size before fetching items.

Deletes a record from a key-value store by its key. Returns 204 No Content on success. The record is permanently removed.

Retrieves a record from a key-value store by its key. Key-value stores hold any data type: JSON, images, PDFs, etc. Returns the record content with appropriate content type.

Stores a record in a key-value store. Set Content-Type header to match data type (application/json, image/png, etc.). Overwrites existing record with same key.

Creates an Actor task with saved Actor ID, input, and run options. Tasks allow running the same Actor with predefined settings repeatedly. Returns the created task with ID.

Permanently deletes an Actor task. This action cannot be undone. Associated runs and their data are NOT deleted. Returns 204 No Content.

Retrieves details of an Actor task. Returns saved input, run options, linked Actor, and stats. Use to inspect task configuration before running.

Aborts a running Actor build immediately. Build status changes to ABORTED. Use when a build is stuck or no longer needed.

Retrieves details of a specific Actor build. Returns status, build number, start/finish times, and version info. Use to monitor build progress or check build details.

Retrieves items (results) from an Apify dataset. Datasets store output from Actor runs. Get results in JSON, CSV, XML, or other formats. Supports pagination and field selection.

Pushes (appends) items to a dataset. Send a JSON array of objects in the request body. Items are appended to the end of the dataset. Returns 201 Created on success.

Adds multiple URL requests to a queue in one batch (max 25). Returns processedRequests and unprocessedRequests arrays. Use exponential backoff for retrying unprocessed items.

Lists requests in a request queue. Returns URLs, their status (pending/handled), and metadata. Use the cursor param for cursor-based pagination.

Creates a webhook that fires when specified events occur. Define event types (run succeeded, failed, etc.), target URL, and which Actor/task to watch. Returns created webhook with ID.

Permanently deletes a webhook. It will no longer fire for any events. Returns 204 No Content on success.

Lists Actors accessible to your account. Set my=true for your own Actors only. Returns Actor IDs, names, descriptions, and run counts. Use to discover available scrapers.

Lists all builds of an Actor. Returns build IDs, status, version info, and timestamps. Builds are compiled versions of the Actor's source code ready to run.

Lists all datasets in your account. Returns dataset IDs, names, item counts, and creation dates. Datasets are created automatically for each Actor run or can be created manually.

Lists all keys in a key-value store. Returns key names, sizes, and public record URLs. Use exclusiveStartKey for cursor-based pagination through large stores.

Lists all key-value stores in your account. Returns store IDs, names, creation dates, and access info. Each Actor run creates a default key-value store.

Adds a single URL request to a request queue. Provide URL and optional metadata. Set forefront=true for priority processing. Duplicate URLs (by uniqueKey) are ignored.

Creates a named request queue for managing URLs to crawl. If a queue with the given name already exists, returns the existing one (idempotent). Returns queue object with ID.

Lists all runs of an Actor with status and metadata. Filter by status, sort by date, paginate results. Returns run IDs, status, timing, and dataset IDs for each run.

Lists all schedules for automated Actor runs. Returns schedule IDs, names, cron expressions, and associated Actor/task info. Use to manage recurring scraping jobs.

Lists all Actor tasks in your account. Tasks are saved configurations (Actor + input) that can be run repeatedly. Returns task IDs, names, and linked Actor info.

Retrieves information about the authenticated user. Returns account details and plan limits. Use to verify account configuration and read plan ceilings.

Lists all webhooks in your account. Returns webhook IDs, event types, target URLs, and associated Actors/tasks. Use to manage notification and integration hooks.