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.
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.
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:
Parameter
Type
Required
Default
Description
actorId
string
Yes
—
Actor ID (e.g., “nwua9Gu5YrADL7ZDj”) or usernameactorName format (e.g., “apifyweb-scraper”, “apifyinstagram-scraper”). Note: Use tilde () separator, not slash.
input
object
No
—
Input object for the actor. The schema depends on the specific actor. Check the actor documentation for required fields.
build
string
No
—
Tag or number of the actor build to run. Defaults to the latest build.
timeoutSecs
number
No
—
Timeout for the actor run in seconds. Default depends on the actor settings.
memoryMbytes
number
No
—
Memory limit for the actor run in megabytes (128, 256, 512, 1024, 2048, 4096, etc.)
waitForFinish
number
No
60
Maximum time to wait for the actor to finish in seconds. Set to 0 for async execution. Default: 60
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "actorId": { "type": "string", "description": "Actor ID (e.g., \"nwua9Gu5YrADL7ZDj\") or username~actorName format (e.g., \"apify~web-scraper\", \"apify~instagram-scraper\"). Note: Use tilde (~) separator, not slash." }, "input": { "type": "object", "additionalProperties": true, "description": "Input object for the actor. The schema depends on the specific actor. Check the actor documentation for required fields." }, "build": { "type": "string", "description": "Tag or number of the actor build to run. Defaults to the latest build." }, "timeoutSecs": { "type": "number", "description": "Timeout for the actor run in seconds. Default depends on the actor settings." }, "memoryMbytes": { "type": "number", "description": "Memory limit for the actor run in megabytes (128, 256, 512, 1024, 2048, 4096, etc.)" }, "waitForFinish": { "type": "number", "default": 60, "description": "Maximum time to wait for the actor to finish in seconds. Set to 0 for async execution. Default: 60" } }, "required": [ "PCID", "actorId" ]}
Get the status and details of an actor run. Use this to check if a run has completed and to retrieve its results.Parameters:
Parameter
Type
Required
Default
Description
runId
string
Yes
—
The ID of the actor run to retrieve
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "runId": { "type": "string", "description": "The ID of the actor run to retrieve" } }, "required": [ "PCID", "runId" ]}
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:
Parameter
Type
Required
Default
Description
datasetId
string
Yes
—
Dataset ID. Get this from the actor run result (defaultDatasetId) or use “default” for the default dataset.
offset
number
No
0
Number of items to skip from the beginning. Default: 0
limit
number
No
100
Maximum number of items to return. Default: 100, Max: 250000
clean
boolean
No
—
If true, returns only non-empty items and skips hidden fields (starting with #)
fields
string[]
No
—
List of fields to include in the output. If not provided, all fields are returned.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "datasetId": { "type": "string", "description": "Dataset ID. Get this from the actor run result (defaultDatasetId) or use \"default\" for the default dataset." }, "offset": { "type": "number", "default": 0, "description": "Number of items to skip from the beginning. Default: 0" }, "limit": { "type": "number", "default": 100, "description": "Maximum number of items to return. Default: 100, Max: 250000" }, "clean": { "type": "boolean", "description": "If true, returns only non-empty items and skips hidden fields (starting with #)" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "List of fields to include in the output. If not provided, all fields are returned." } }, "required": [ "PCID", "datasetId" ]}
Abort a running actor run. Use this to stop a run that is taking too long or is no longer needed.Parameters:
Parameter
Type
Required
Default
Description
runId
string
Yes
—
The ID of the actor run to abort
gracefully
boolean
No
false
If true, the actor run will be given some time to clean up before being aborted. Default: false
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "runId": { "type": "string", "description": "The ID of the actor run to abort" }, "gracefully": { "type": "boolean", "default": false, "description": "If true, the actor run will be given some time to clean up before being aborted. Default: false" } }, "required": [ "PCID", "runId" ]}
Get a specific record from a key-value store. Key-value stores hold various data like screenshots, HTML snapshots, or JSON configuration.Parameters:
Parameter
Type
Required
Default
Description
storeId
string
Yes
—
Key-value store ID. Get this from actor run result (defaultKeyValueStoreId) or use a named store ID.
key
string
Yes
—
The key of the record to retrieve (e.g., “OUTPUT”, “INPUT”, “screenshot.png”)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "storeId": { "type": "string", "description": "Key-value store ID. Get this from actor run result (defaultKeyValueStoreId) or use a named store ID." }, "key": { "type": "string", "description": "The key of the record to retrieve (e.g., \"OUTPUT\", \"INPUT\", \"screenshot.png\")" } }, "required": [ "PCID", "storeId", "key" ]}
Retrieve the logs for a specific Actor run. Useful for debugging failed runs or monitoring progress.Parameters:
Parameter
Type
Required
Default
Description
runId
string
Yes
—
The ID of the actor run to get logs for
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "runId": { "type": "string", "description": "The ID of the actor run to get logs for" } }, "required": [ "PCID", "runId" ]}
Get metadata about a specific dataset including item count, size, and creation date.Parameters:
Parameter
Type
Required
Default
Description
datasetId
string
Yes
—
Dataset ID. Get this from an actor run result (defaultDatasetId).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "datasetId": { "type": "string", "description": "Dataset ID. Get this from an actor run result (defaultDatasetId)." } }, "required": [ "PCID", "datasetId" ]}
Get metadata about a specific key-value store including record count and size.Parameters:
Parameter
Type
Required
Default
Description
storeId
string
Yes
—
Key-value store ID. Get this from an actor run result (defaultKeyValueStoreId).
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "storeId": { "type": "string", "description": "Key-value store ID. Get this from an actor run result (defaultKeyValueStoreId)." } }, "required": [ "PCID", "storeId" ]}