Skip to main content
Server path: /apify | Type: Application | PCID required: Yes Web scraping and automation

Tools

ToolDescription
apify_run_actorRun an Apify Actor with the specified input. Actors are pre-built automation tools for web scraping, data extraction, and browser automation. Use this to start a new run of any actor from the Apify Store or your own actors.
apify_get_runGet the status and details of an actor run. Use this to check if a run has completed and to retrieve its results.
apify_get_dataset_itemsRetrieve items from an Apify dataset. Datasets store structured data from actor runs. Use this to get the scraped/extracted data after an actor run completes.
apify_list_actorsList actors owned by the authenticated user. Use this to discover available actors in your account.
apify_list_runsList runs of a specific actor or all runs. Use this to see the history of actor executions.
apify_abort_runAbort a running actor run. Use this to stop a run that is taking too long or is no longer needed.
apify_get_key_value_store_recordGet a specific record from a key-value store. Key-value stores hold various data like screenshots, HTML snapshots, or JSON configuration.
apify_search_store_actorsSearch for actors in the Apify Store. Use this to discover pre-built actors for web scraping, automation, and data extraction tasks.
apify_get_actor_detailsRetrieve detailed information about a specific Actor including its input schema, README, and version info.
apify_get_run_logRetrieve the logs for a specific Actor run. Useful for debugging failed runs or monitoring progress.
apify_get_datasetGet metadata about a specific dataset including item count, size, and creation date.
apify_get_dataset_schemaGenerate a JSON schema from the items in a dataset. Useful for understanding the structure of scraped data.
apify_get_key_value_storeGet metadata about a specific key-value store including record count and size.
apify_list_key_value_store_keysList all keys within a specific key-value store. Use this to discover what data is stored.
apify_list_datasetsList all datasets available to the user. Datasets store structured data from actor runs.
apify_list_key_value_storesList all key-value stores available to the user. Key-value stores hold various data like screenshots, HTML, or JSON.
apify_search_docsSearch the Apify documentation for relevant pages. Use this to find information about Apify features, APIs, and best practices.
apify_get_docFetch the full content of an Apify documentation page by its URL. Use after searching to get detailed information.

apify_run_actor

Run an Apify Actor with the specified input. Actors are pre-built automation tools for web scraping, data extraction, and browser automation. Use this to start a new run of any actor from the Apify Store or your own actors. Parameters:
ParameterTypeRequiredDefaultDescription
actorIdstringYesActor ID (e.g., “nwua9Gu5YrADL7ZDj”) or usernameactorName format (e.g., “apifyweb-scraper”, “apifyinstagram-scraper”). Note: Use tilde () separator, not slash.
inputobjectNoInput object for the actor. The schema depends on the specific actor. Check the actor documentation for required fields.
buildstringNoTag or number of the actor build to run. Defaults to the latest build.
timeoutSecsnumberNoTimeout for the actor run in seconds. Default depends on the actor settings.
memoryMbytesnumberNoMemory limit for the actor run in megabytes (128, 256, 512, 1024, 2048, 4096, etc.)
waitForFinishnumberNo60Maximum time to wait for the actor to finish in seconds. Set to 0 for async execution. Default: 60

apify_get_run

Get the status and details of an actor run. Use this to check if a run has completed and to retrieve its results. Parameters:
ParameterTypeRequiredDefaultDescription
runIdstringYesThe ID of the actor run to retrieve

apify_get_dataset_items

Retrieve items from an Apify dataset. Datasets store structured data from actor runs. Use this to get the scraped/extracted data after an actor run completes. Parameters:
ParameterTypeRequiredDefaultDescription
datasetIdstringYesDataset ID. Get this from the actor run result (defaultDatasetId) or use “default” for the default dataset.
offsetnumberNo0Number of items to skip from the beginning. Default: 0
limitnumberNo100Maximum number of items to return. Default: 100, Max: 250000
cleanbooleanNoIf true, returns only non-empty items and skips hidden fields (starting with #)
fieldsstring[]NoList of fields to include in the output. If not provided, all fields are returned.

apify_list_actors

List actors owned by the authenticated user. Use this to discover available actors in your account. Parameters:
ParameterTypeRequiredDefaultDescription
offsetnumberNo0Number of actors to skip. Default: 0
limitnumberNo20Maximum number of actors to return. Default: 20
descbooleanNoIf true, sort by createdAt in descending order

apify_list_runs

List runs of a specific actor or all runs. Use this to see the history of actor executions. Parameters:
ParameterTypeRequiredDefaultDescription
actorIdstringNoActor ID to filter runs. If not provided, lists all runs across all actors.
offsetnumberNo0Number of runs to skip. Default: 0
limitnumberNo20Maximum number of runs to return. Default: 20
statusstringNoFilter by run status
descbooleanNotrueIf true, sort by startedAt in descending order. Default: true

apify_abort_run

Abort a running actor run. Use this to stop a run that is taking too long or is no longer needed. Parameters:
ParameterTypeRequiredDefaultDescription
runIdstringYesThe ID of the actor run to abort
gracefullybooleanNofalseIf true, the actor run will be given some time to clean up before being aborted. Default: false

apify_get_key_value_store_record

Get a specific record from a key-value store. Key-value stores hold various data like screenshots, HTML snapshots, or JSON configuration. Parameters:
ParameterTypeRequiredDefaultDescription
storeIdstringYesKey-value store ID. Get this from actor run result (defaultKeyValueStoreId) or use a named store ID.
keystringYesThe key of the record to retrieve (e.g., “OUTPUT”, “INPUT”, “screenshot.png”)

apify_search_store_actors

Search for actors in the Apify Store. Use this to discover pre-built actors for web scraping, automation, and data extraction tasks. Parameters:
ParameterTypeRequiredDefaultDescription
searchstringNoSearch term to filter actors by name, title, or description
categorystringNoFilter by category (e.g., “ECOMMERCE”, “SOCIAL_MEDIA”, “TRAVEL”)
offsetnumberNo0Number of actors to skip. Default: 0
limitnumberNo20Maximum number of actors to return. Default: 20
sortBystringNoSort order for results

apify_get_actor_details

Retrieve detailed information about a specific Actor including its input schema, README, and version info. Parameters:
ParameterTypeRequiredDefaultDescription
actorIdstringYesActor ID (e.g., “nwua9Gu5YrADL7ZDj”) or usernameactorName format (e.g., “apifyweb-scraper”). Note: Use tilde (~) separator, not slash.

apify_get_run_log

Retrieve the logs for a specific Actor run. Useful for debugging failed runs or monitoring progress. Parameters:
ParameterTypeRequiredDefaultDescription
runIdstringYesThe ID of the actor run to get logs for

apify_get_dataset

Get metadata about a specific dataset including item count, size, and creation date. Parameters:
ParameterTypeRequiredDefaultDescription
datasetIdstringYesDataset ID. Get this from an actor run result (defaultDatasetId).

apify_get_dataset_schema

Generate a JSON schema from the items in a dataset. Useful for understanding the structure of scraped data. Parameters:
ParameterTypeRequiredDefaultDescription
datasetIdstringYesDataset ID to generate schema from

apify_get_key_value_store

Get metadata about a specific key-value store including record count and size. Parameters:
ParameterTypeRequiredDefaultDescription
storeIdstringYesKey-value store ID. Get this from an actor run result (defaultKeyValueStoreId).

apify_list_key_value_store_keys

List all keys within a specific key-value store. Use this to discover what data is stored. Parameters:
ParameterTypeRequiredDefaultDescription
storeIdstringYesKey-value store ID
exclusiveStartKeystringNoKey to start listing from (for pagination)
limitnumberNo100Maximum number of keys to return. Default: 100

apify_list_datasets

List all datasets available to the user. Datasets store structured data from actor runs. Parameters:
ParameterTypeRequiredDefaultDescription
offsetnumberNo0Number of datasets to skip. Default: 0
limitnumberNo20Maximum number of datasets to return. Default: 20
unnamedbooleanNotrueIf true, include unnamed datasets. Default: true
descbooleanNoIf true, sort by createdAt in descending order

apify_list_key_value_stores

List all key-value stores available to the user. Key-value stores hold various data like screenshots, HTML, or JSON. Parameters:
ParameterTypeRequiredDefaultDescription
offsetnumberNo0Number of stores to skip. Default: 0
limitnumberNo20Maximum number of stores to return. Default: 20
unnamedbooleanNotrueIf true, include unnamed stores. Default: true
descbooleanNoIf true, sort by createdAt in descending order

apify_search_docs

Search the Apify documentation for relevant pages. Use this to find information about Apify features, APIs, and best practices. Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesSearch query to find relevant documentation pages

apify_get_doc

Fetch the full content of an Apify documentation page by its URL. Use after searching to get detailed information. Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesURL of the Apify documentation page (e.g., “https://docs.apify.com/platform/actors”)