apify

Web scraping and automation

Server path: /apify | Type: Application | PCID required: Yes

Tools

Tool	Description
apify_abort_run	Abort a running actor run. Use this to stop a run that is taking too long or is no longer needed.
apify_get_actor_details	Retrieve detailed information about a specific Actor including its input schema, README, and version info.
apify_get_dataset	Get metadata about a specific dataset including item count, size, and creation date.
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.
apify_get_dataset_schema	Generate a JSON schema from the items in a dataset. Useful for understanding the structure of scraped data.
apify_get_doc	Fetch the full content of an Apify documentation page by its URL. Use after searching to get detailed information.
apify_get_key_value_store	Get metadata about a specific key-value store including record count and size.
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.
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.
apify_get_run_log	Retrieve the logs for a specific Actor run. Useful for debugging failed runs or monitoring progress.
apify_list_actors	List actors owned by the authenticated user. Use this to discover available actors in your account.
apify_list_datasets	List all datasets available to the user. Datasets store structured data from actor runs.
apify_list_key_value_store_keys	List all keys within a specific key-value store. Use this to discover what data is stored.
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.
apify_list_runs	List runs of a specific actor or all runs. Use this to see the history of actor executions.
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.
apify_search_docs	Search the Apify documentation for relevant pages. Use this to find information about Apify features, APIs, and best practices.
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.

---

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:

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"
  ]
}

---

apify_get_actor_details

Retrieve detailed information about a specific Actor including its input schema, README, and version info.

Parameters:

Parameter	Type	Required	Default	Description
actorId	string	Yes	—	Actor ID (e.g., “nwua9Gu5YrADL7ZDj”) or usernameactorName format (e.g., “apifyweb-scraper”). Note: Use tilde (~) separator, not slash.

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\"). Note: Use tilde (~) separator, not slash."
    }
  },
  "required": [
    "PCID",
    "actorId"
  ]
}

---

apify_get_dataset

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"
  ]
}

---

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:

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"
  ]
}

---

apify_get_dataset_schema

Generate a JSON schema from the items in a dataset. Useful for understanding the structure of scraped data.

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	Dataset ID to generate schema from

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "datasetId": {
      "type": "string",
      "description": "Dataset ID to generate schema from"
    }
  },
  "required": [
    "PCID",
    "datasetId"
  ]
}

---

apify_get_doc

Fetch the full content of an Apify documentation page by its URL. Use after searching to get detailed information.

Parameters:

Parameter	Type	Required	Default	Description
url	string	Yes	—	URL of the Apify documentation page (e.g., “https://docs.apify.com/platform/actors”)

Show inputSchema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "URL of the Apify documentation page (e.g., \"https://docs.apify.com/platform/actors\")"
    }
  },
  "required": [
    "url"
  ]
}

---

apify_get_key_value_store

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"
  ]
}

---

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:

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"
  ]
}

---

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:

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"
  ]
}

---

apify_get_run_log

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"
  ]
}

---

apify_list_actors

List actors owned by the authenticated user. Use this to discover available actors in your account.

Parameters:

Parameter	Type	Required	Default	Description
offset	number	No	0	Number of actors to skip. Default: 0
limit	number	No	20	Maximum number of actors to return. Default: 20
desc	boolean	No	—	If true, sort by createdAt in descending order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "offset": {
      "type": "number",
      "default": 0,
      "description": "Number of actors to skip. Default: 0"
    },
    "limit": {
      "type": "number",
      "default": 20,
      "description": "Maximum number of actors to return. Default: 20"
    },
    "desc": {
      "type": "boolean",
      "description": "If true, sort by createdAt in descending order"
    }
  },
  "required": [
    "PCID"
  ]
}

---

apify_list_datasets

List all datasets available to the user. Datasets store structured data from actor runs.

Parameters:

Parameter	Type	Required	Default	Description
offset	number	No	0	Number of datasets to skip. Default: 0
limit	number	No	20	Maximum number of datasets to return. Default: 20
unnamed	boolean	No	true	If true, include unnamed datasets. Default: true
desc	boolean	No	—	If true, sort by createdAt in descending order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "offset": {
      "type": "number",
      "default": 0,
      "description": "Number of datasets to skip. Default: 0"
    },
    "limit": {
      "type": "number",
      "default": 20,
      "description": "Maximum number of datasets to return. Default: 20"
    },
    "unnamed": {
      "type": "boolean",
      "default": true,
      "description": "If true, include unnamed datasets. Default: true"
    },
    "desc": {
      "type": "boolean",
      "description": "If true, sort by createdAt in descending order"
    }
  },
  "required": [
    "PCID"
  ]
}

---

apify_list_key_value_store_keys

List all keys within a specific key-value store. Use this to discover what data is stored.

Parameters:

Parameter	Type	Required	Default	Description
storeId	string	Yes	—	Key-value store ID
exclusiveStartKey	string	No	—	Key to start listing from (for pagination)
limit	number	No	100	Maximum number of keys to return. Default: 100

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "storeId": {
      "type": "string",
      "description": "Key-value store ID"
    },
    "exclusiveStartKey": {
      "type": "string",
      "description": "Key to start listing from (for pagination)"
    },
    "limit": {
      "type": "number",
      "default": 100,
      "description": "Maximum number of keys to return. Default: 100"
    }
  },
  "required": [
    "PCID",
    "storeId"
  ]
}

---

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:

Parameter	Type	Required	Default	Description
offset	number	No	0	Number of stores to skip. Default: 0
limit	number	No	20	Maximum number of stores to return. Default: 20
unnamed	boolean	No	true	If true, include unnamed stores. Default: true
desc	boolean	No	—	If true, sort by createdAt in descending order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "offset": {
      "type": "number",
      "default": 0,
      "description": "Number of stores to skip. Default: 0"
    },
    "limit": {
      "type": "number",
      "default": 20,
      "description": "Maximum number of stores to return. Default: 20"
    },
    "unnamed": {
      "type": "boolean",
      "default": true,
      "description": "If true, include unnamed stores. Default: true"
    },
    "desc": {
      "type": "boolean",
      "description": "If true, sort by createdAt in descending order"
    }
  },
  "required": [
    "PCID"
  ]
}

---

apify_list_runs

List runs of a specific actor or all runs. Use this to see the history of actor executions.

Parameters:

Parameter	Type	Required	Default	Description
actorId	string	No	—	Actor ID to filter runs. If not provided, lists all runs across all actors.
offset	number	No	0	Number of runs to skip. Default: 0
limit	number	No	20	Maximum number of runs to return. Default: 20
status	string	No	—	Filter by run status
desc	boolean	No	true	If true, sort by startedAt in descending order. Default: true

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "actorId": {
      "type": "string",
      "description": "Actor ID to filter runs. If not provided, lists all runs across all actors."
    },
    "offset": {
      "type": "number",
      "default": 0,
      "description": "Number of runs to skip. Default: 0"
    },
    "limit": {
      "type": "number",
      "default": 20,
      "description": "Maximum number of runs to return. Default: 20"
    },
    "status": {
      "type": "string",
      "enum": [
        "READY",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "ABORTING",
        "ABORTED",
        "TIMED-OUT"
      ],
      "description": "Filter by run status"
    },
    "desc": {
      "type": "boolean",
      "default": true,
      "description": "If true, sort by startedAt in descending order. Default: true"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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:

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"
  ]
}

---

apify_search_docs

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

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	Search query to find relevant documentation pages

Show inputSchema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query to find relevant documentation pages"
    }
  },
  "required": [
    "query"
  ]
}

---

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:

Parameter	Type	Required	Default	Description
search	string	No	—	Search term to filter actors by name, title, or description
category	string	No	—	Filter by category (e.g., “ECOMMERCE”, “SOCIAL_MEDIA”, “TRAVEL”)
offset	number	No	0	Number of actors to skip. Default: 0
limit	number	No	20	Maximum number of actors to return. Default: 20
sortBy	string	No	—	Sort order for results

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "PinkConnect ID for Apify connection"
    },
    "search": {
      "type": "string",
      "description": "Search term to filter actors by name, title, or description"
    },
    "category": {
      "type": "string",
      "description": "Filter by category (e.g., \"ECOMMERCE\", \"SOCIAL_MEDIA\", \"TRAVEL\")"
    },
    "offset": {
      "type": "number",
      "default": 0,
      "description": "Number of actors to skip. Default: 0"
    },
    "limit": {
      "type": "number",
      "default": 20,
      "description": "Maximum number of actors to return. Default: 20"
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "popularity",
        "newest",
        "lastUpdate"
      ],
      "description": "Sort order for results"
    }
  },
  "required": [
    "PCID"
  ]
}