com.mcparmory/apify
PYPI · MCPARMORY-APIFY · 2 COMPONENTS · SCANNED SEP 20
Build, deploy, and run web scraping and automation actors in the cloud
Available components
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score → Why this is hard to score →
Supply Chain Security87
- No malware found by supply-chain analysis.Pass
- No known CVEs affecting this package version or its production dependencies.Pass
- Install-script risk not yet assessed.Unverified
- 2 of 41 dependencies flagged as unhealthy. View diagnostics → Partial
Provenance & Transparency32
- Source repository is publicly reachable at the declared URL. View diagnostics → Pass
- Provenance check failed: no build-provenance attestation is published. See how to fix → View diagnostics → Fail
- License check failed: the license (MIT License) isn't a recognized OSI-approved license. See how to fix → Fail
- Actively maintained (last published 131 days ago).Pass
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability68
- AI-judged instruction clarity (excellent).Pass
- Context-footprint check failed: tool/resource definitions use about 23887 tokens (~213/item across 112 items; 112 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management87
- Stability observed for 26 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
Tool Safety97
- No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.Pass
- 15 of 17 tool(s) whose name or description implies an irreversible operation declare an MCP destructiveHint annotation; "charge_run_event" implies "charge" and declares no destructiveHint at all, which the MCP spec reads as destructive by default. See how to fix → Partial
- An AI judge read all 112 captured unit(s) of tool text and found none that tries to manipulate the model reading it.Pass
Capabilities100
- Implements a current MCP spec version (2026-07-28).Pass
How do I install the com.mcparmory/apify MCP server?
com.mcparmory/apify runs locally as a PyPI package, launched with uvx mcparmory-apify. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.
pypi · mcparmory-apify
claude mcp add com-mcparmory-apify -- uvx mcparmory-apify
{
"mcpServers": {
"com-mcparmory-apify": {
"command": "uvx",
"args": [
"mcparmory-apify"
]
}
}
} {
"servers": {
"com-mcparmory-apify": {
"command": "uvx",
"args": [
"mcparmory-apify"
]
}
}
} codex mcp add com-mcparmory-apify -- uvx mcparmory-apify
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"com-mcparmory-apify": {
"type": "local",
"command": [
"uvx",
"mcparmory-apify"
],
"enabled": true
}
}
} openclaw mcp add com-mcparmory-apify --command uvx --arg mcparmory-apify
mcp_servers:
com-mcparmory-apify:
command: "uvx"
args: ["mcparmory-apify"] {
"McpServers": {
"com-mcparmory-apify": {
"Transport": "stdio",
"Command": "uvx",
"Arguments": [
"mcparmory-apify"
]
}
}
} assistant mcp add com-mcparmory-apify -t stdio -c uvx -a mcparmory-apify
{
"mcpServers": {
"com-mcparmory-apify": {
"command": "uvx",
"args": [
"mcparmory-apify"
]
}
}
} Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 20 Sept 26 +16
- Malware scan: unverified → pass ▲ security
- 18 Sept 26 −3
- Stability: pass → 0.80 functional
- 17 Sept 26 −14
- Malware scan: pass → unverified ▼ security
- Stability: 0.97 → pass security
- 15 Sept 26 +16
- Malware scan: unverified → pass ▲ security
- 14 Sept 26 −15
- Malware scan: pass → unverified ▼ security
- 13 Sept 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 83 to 87. That category is still filling its 30-day observation window: 25 days of observed history at the previous scan, 26 at this one. The score rises as the window fills, whether or not the server changes.
- 12 Sept 26 +15
- Malware scan: unverified → pass ▲ security
- 11 Sept 26 −18
- Malware scan: pass → unverified ▼ security
- Stability: pass → 0.80 functional
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 20 Sept 2026 · Analysed pypi/mcparmory-apify@1.0.5
Provenance No attestation
The registry publishes no build provenance for this version, so there is nothing to verify.
| Result | No attestation |
|---|---|
| Ecosystem | pypi |
Background: How many MCP packages publish verified provenance →
Dependencies 41 packages
| Packages resolved | 41 |
|---|---|
| Stale | 1 |
| No linked repository | 1 |
| Tree resolution | Complete |
Background: SBOMs and build attestations, explained →
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability. A tool's description is untrusted text the model reads on every call, which is what makes this list a security surface and not just an inventory: how tool poisoning works →
get_request_queue_head Get Request Queue Head ~165
Retrieves the first N requests from the head of a request queue. Returns a `hadMultipleClients` flag indicating whether the queue has been accessed by more than one client, which helps SDKs determine local cache consistency.
| Name | Type | Req | Description |
|---|---|---|---|
| clientKey | string | – | A unique string identifier (1–32 characters) representing the calling client, used to track whether the queue is being accessed by multiple clients. Omitting this value causes the system to treat the… |
| limit | number | – | The maximum number of requests to return from the head of the queue. If omitted, a default limit is applied. |
| queueId | string | yes | The unique ID of the request queue, or a combined identifier in the format `username~queue-name`. |
No output schema declared.
No examples provided.
get_run_log Get Run Log ~131
Retrieves the log output for a specific Actor build or run. Supports real-time streaming for active runs and optional preservation of raw ANSI escape codes.
| Name | Type | Req | Description |
|---|---|---|---|
| buildOrRunId | string | yes | The unique identifier of the Actor build or run whose logs you want to retrieve. |
| raw | boolean | – | When set to true, logs are returned verbatim including ANSI escape codes. By default, ANSI escape codes are stripped and only printable characters are returned. |
| stream | boolean | – | When set to true, the response streams log output continuously while the build or run is still active, rather than returning a static snapshot. |
No output schema declared.
No examples provided.
get_schedule Get Schedule ~54
Retrieves a schedule object with all associated details by its unique identifier. Use this to inspect scheduling configuration, timing, and related metadata for a specific schedule.
| Name | Type | Req | Description |
|---|---|---|---|
| scheduleId | string | yes | The unique identifier of the schedule to retrieve. |
No output schema declared.
No examples provided.
get_schedule_log Get Schedule Log ~63
Retrieves the execution log for a specific schedule, returning a JSON array of up to 1000 recent invocation records. Useful for auditing schedule activity and diagnosing execution history.
| Name | Type | Req | Description |
|---|---|---|---|
| scheduleId | string | yes | The unique identifier of the schedule whose invocation log you want to retrieve. |
No output schema declared.
No examples provided.
get_task Get Task ~79
Retrieve full details of a specific actor task, including its configuration, settings, and metadata. Use this to inspect an existing task before running or modifying it.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the task to retrieve, either as a standalone task ID or as a tilde-separated combination of the owner's username and the task's name. |
No output schema declared.
No examples provided.
get_task_input Get Task Input ~75
Retrieves the input configuration for a specified actor task. Returns the input object that defines the parameters passed to the actor when the task runs.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the actor task, either as a standalone task ID or as a tilde-separated combination of the owner's username and the task's name. |
No output schema declared.
No examples provided.
get_user Get User ~61
Retrieves public profile information for a specific user account, equivalent to what is visible on their public profile page. No authentication is required to call this endpoint.
| Name | Type | Req | Description |
|---|---|---|---|
| userId | string | yes | The unique identifier or username of the user whose public profile data should be retrieved. |
No output schema declared.
No examples provided.
get_webhook Get Webhook ~44
Retrieves full details of a specific webhook by its unique identifier. Returns all webhook configuration and metadata.
| Name | Type | Req | Description |
|---|---|---|---|
| webhookId | string | yes | The unique identifier of the webhook to retrieve. |
No output schema declared.
No examples provided.
get_webhook_dispatch Get Webhook Dispatch ~51
Retrieves a webhook dispatch record by its unique ID, returning full details about the dispatch event, status, and payload.
| Name | Type | Req | Description |
|---|---|---|---|
| dispatchId | string | yes | The unique identifier of the webhook dispatch record to retrieve. |
No output schema declared.
No examples provided.
list_actor_builds List Actor Builds ~182
Retrieves a paginated list of builds for a specific Actor, with each record containing basic build information. Results are sorted by start time in ascending order by default, supporting incremental fetching as new builds are created.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor, either as a plain Actor ID or in tilde-separated format combining the owner's username and Actor name. |
| desc | boolean | – | When set to true, sorts the returned builds by their start time in descending order (newest first). Defaults to ascending order. |
| limit | number | – | Maximum number of build records to return in a single response. Accepts values up to 1000, which is also the default. |
| offset | number | – | Number of build records to skip from the beginning of the result set, used for paginating through results. Defaults to 0. |
No output schema declared.
No examples provided.
list_actor_runs List Actor Runs ~234
Retrieves a paginated list of all Actor runs for the authenticated user, with each item containing basic run metadata. Supports filtering by status and start time, and sorting in ascending or descending order.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, sorts runs by their start time in descending order (newest first); defaults to ascending order. |
| limit | number | – | Maximum number of runs to return per request; cannot exceed 1000. |
| offset | number | – | Number of runs to skip from the beginning of the result set, used for pagination. |
| startedAfter | string | – | Filters results to only runs that started at or after this point in time; must be a valid ISO 8601 datetime string in UTC. |
| startedBefore | string | – | Filters results to only runs that started at or before this point in time; must be a valid ISO 8601 datetime string in UTC. |
| status | string | – | Filters results to only runs matching the given status or statuses; accepts a single status value or a comma-separated list of status values (e.g., SUCCEEDED, FAILED, RUNNING). |
No output schema declared.
No examples provided.
list_actor_runs_by_actor List Actor Runs ~263
Retrieves a paginated list of runs for a specific Actor, with each item containing basic run metadata. Supports filtering by status and start time, and sorting in ascending or descending order.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor, either as an Actor ID or a tilde-separated combination of the owner's username and Actor name. |
| desc | boolean | – | When set to true, sorts runs by their start time in descending order (newest first); defaults to ascending order. |
| limit | number | – | Maximum number of runs to return in a single response; cannot exceed 1000. |
| offset | number | – | Number of runs to skip from the beginning of the result set, used for paginating through results. |
| startedAfter | string | – | Filters results to only include runs that started at or after this point in time, specified as an ISO 8601 datetime string in UTC. |
| startedBefore | string | – | Filters results to only include runs that started at or before this point in time, specified as an ISO 8601 datetime string in UTC. |
| status | string | – | Filters results to only include runs matching the specified status or comma-separated list of statuses (e.g., SUCCEEDED, FAILED, RUNNING). |
No output schema declared.
No examples provided.
list_actor_version_env_vars List Actor Version Environment Variables ~106
Retrieves all environment variables configured for a specific version of an Actor. Returns a list of environment variable objects, each containing the variable's key, value, and related metadata.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor, either as an Actor ID or a tilde-separated combination of the owner's username and Actor name. |
| versionNumber | string | yes | The version number of the Actor whose environment variables should be retrieved, following major.minor versioning format. |
No output schema declared.
No examples provided.
list_actor_versions List Actor Versions ~65
Retrieves all versions of a specific Actor, returning a list of Version objects with basic information about each version.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor, either as a standalone Actor ID or as a tilde-separated combination of the owner's username and Actor name. |
No output schema declared.
No examples provided.
list_actor_webhooks List Actor Webhooks ~185
Retrieves a paginated list of webhooks associated with a specific Actor, returning basic information about each webhook. Results are sorted by creation date ascending by default, with a maximum of 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor, either as a standalone Actor ID or as a tilde-separated combination of the owner's username and Actor name. |
| desc | boolean | – | When set to true, reverses the sort order so that the most recently created webhooks appear first instead of last. |
| limit | number | – | Maximum number of webhooks to return in a single response. Accepts values between 1 and 1000, defaulting to 1000. |
| offset | number | – | Number of webhooks to skip from the beginning of the result set, used for paginating through records. Defaults to 0. |
No output schema declared.
No examples provided.
list_actors List Actors ~242
Retrieves a paginated list of Actors the user has created or used, with options to filter to owned Actors only and sort by creation date or last run time. Returns up to 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, reverses the sort order so that the most recently created (or most recently run, if sorting by last run) Actors appear first. |
| limit | number | – | Maximum number of Actors to return in a single response. Accepts values between 1 and 1000, with 1000 being both the default and the upper limit. |
| my | boolean | – | When set to true, restricts the results to only Actors owned by the authenticated user, excluding Actors they have used but not created. |
| offset | number | – | Number of records to skip from the beginning of the result set, used for paginating through large lists. Defaults to 0. |
| sortBy | string | – | Determines the field used to order results. Use 'createdAt' to sort by when the Actor was created, or 'stats.lastRunStartedAt' to sort by the most recent run start time. |
No output schema declared.
No examples provided.
list_builds List Actor Builds ~136
Retrieves a paginated list of all builds for the authenticated user, with each entry containing basic build information. Records are sorted by start time and the endpoint returns a maximum of 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, sorts builds by their start time in descending order (newest first); defaults to ascending order (oldest first). |
| limit | number | – | Maximum number of builds to return in a single response, capped at 1000 records. |
| offset | number | – | Number of builds to skip from the beginning of the result set, used for paginating through large result sets. |
No output schema declared.
No examples provided.
list_dataset_items List Dataset Items ~788
Retrieves items stored in a dataset, supporting multiple output formats (JSON, JSONL, XML, HTML, CSV, XLSX, RSS) with options for pagination, field filtering, sorting, and data transformation. Use this to export or inspect dataset contents produced by an Actor run.
| Name | Type | Req | Description |
|---|---|---|---|
| datasetId | string | yes | The unique identifier of the dataset, either as a dataset ID or in the format `username~dataset-name`. |
| delimiter | string | – | Single character used as the field delimiter in CSV output; only applicable when `format=csv`. URL-encode special characters as needed (e.g., `%09` for tab, `%3B` for semicolon). Defaults to a comma. |
| desc | boolean | – | When set to `true` or `1`, reverses the sort order so items are returned from newest to oldest. By default items are returned in insertion order (oldest first). Note that this does not reverse the or… |
| fields | string | – | Comma-separated list of top-level field names to include in each output item; all other fields are dropped. The order of fields in the output matches the order specified here, which can be used to en… |
| flatten | string | – | Comma-separated list of fields whose nested object values should be flattened into dot-notation keys on the parent object (e.g., `foo.bar`). The original nested object is replaced by the flattened re… |
| format | string | – | Output format for the response. Structured formats (`json`, `jsonl`, `xml`) return raw item objects; tabular formats (`html`, `csv`, `xlsx`) return rows and columns limited to 2000 columns with colum… |
| limit | number | – | Maximum number of items to include in the response. When omitted, all available items are returned. Note that using `skipEmpty` may cause fewer items to be returned than this limit. |
| offset | number | – | Number of items to skip from the beginning of the result set, used for pagination. Defaults to `0`. |
| omit | string | – | Comma-separated list of top-level field names to exclude from each output item; all other fields are retained. |
| skipEmpty | boolean | – | When set to `true` or `1`, excludes empty items from the output. Be aware that the number of returned items may be less than the specified `limit` when this option is active. |
| skipHeaderRow | boolean | – | When set to `true` or `1`, omits the header row from CSV output. Only applicable when `format=csv`. |
| skipHidden | boolean | – | When set to `true` or `1`, excludes hidden fields (top-level fields whose names begin with `#`) from the output. Equivalent to enabling `clean`. |
| unwind | string | – | Comma-separated list of fields to unwind, processed in the specified order. Array fields are expanded so each element becomes a separate item merged with the parent object; object fields are merged d… |
| view | string | – | Name of a predefined view configuration defined in the dataset's schema, which controls how items are filtered and presented. Refer to the dataset schema documentation for how views are defined. |
| xmlRoot | string | – | Overrides the name of the root XML element wrapping all results in XML output. Only applicable when `format=xml`. Defaults to `items`. |
| xmlRow | string | – | Overrides the name of the XML element wrapping each individual item in XML output. Only applicable when `format=xml`. Defaults to `item`. |
No output schema declared.
No examples provided.
list_datasets List Datasets ~215
Retrieves a paginated list of datasets accessible to the user, including basic metadata for each. Supports sorting, filtering by ownership, and optionally including unnamed datasets.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, results are sorted by creation date in descending order (newest first). By default, results are sorted in ascending order. |
| limit | number | – | Maximum number of datasets to return in a single response. Accepts values up to 1000, which is also the default. |
| offset | number | – | Number of datasets to skip from the beginning of the result set, used for pagination. Defaults to 0. |
| ownership | string | – | Filters results by ownership relationship. Use 'ownedByMe' to return only datasets you own, or 'sharedWithMe' to return only datasets shared with you by others. Omit to return all accessible datasets. |
| unnamed | boolean | – | When set to true, both named and unnamed datasets are returned. By default, only named datasets are included in the response. |
No output schema declared.
No examples provided.
list_key_value_store_keys List Key-Value Store Keys ~197
Retrieves a paginated list of keys from a specified key-value store, including metadata about each key's associated value such as size. Supports filtering by collection or key prefix.
| Name | Type | Req | Description |
|---|---|---|---|
| collection | string | – | Restricts results to keys belonging to a specific collection defined in the key-value store's schema. Requires the store to have a schema configured. |
| exclusiveStartKey | string | – | Pagination cursor — all keys up to and including this key are excluded from the results, allowing you to retrieve the next page of keys. |
| limit | number | – | Maximum number of keys to return in a single response. Must be between 1 and 1000. |
| prefix | string | – | Restricts results to keys that begin with the specified string prefix, useful for filtering logically grouped keys. |
| storeId | string | yes | The unique identifier of the key-value store, either as a store ID or in the format username~store-name. |
No output schema declared.
No examples provided.
list_key_value_stores List Key-Value Stores ~183
Retrieves a paginated list of key-value stores accessible to the user, including basic metadata for each store. Results are sorted by creation date ascending by default, supporting incremental pagination as new stores are created.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, reverses the sort order so that the most recently created stores appear first. |
| limit | number | – | Maximum number of stores to return in a single response. Accepts values up to 1000. |
| offset | number | – | Number of stores to skip from the beginning of the result set, used for paginating through results. |
| ownership | string | – | Filters results by ownership relationship. Omitting this parameter returns all accessible stores regardless of ownership. |
| unnamed | boolean | – | When set to true, returns both named and unnamed stores. By default, only named stores are included in the response. |
No output schema declared.
No examples provided.
list_queue_requests List Queue Requests ~123
Retrieves a paginated list of requests from a specified request queue. Use exclusiveStartId and limit to page through large queues efficiently.
| Name | Type | Req | Description |
|---|---|---|---|
| exclusiveStartId | string | – | Cursor for pagination — all requests up to and including this request ID are excluded from the results, returning only subsequent requests. |
| limit | number | – | Maximum number of requests to return in a single response. Must be between 1 and 10000. |
| queueId | string | yes | The unique identifier of the request queue, either as a queue ID or in the format username~queue-name. |
No output schema declared.
No examples provided.
list_request_queues List Request Queues ~207
Retrieves a paginated list of the user's request queues, returning basic metadata for each. Results are sorted by creation date ascending by default, supporting incremental fetching as new queues are created.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, reverses the sort order so queues are returned with the most recently created first instead of oldest first. |
| limit | number | – | Maximum number of queues to return in a single response. Accepts values up to 1000, which is also the default. |
| offset | number | – | Number of queues to skip from the beginning of the result set, used for pagination. Defaults to 0. |
| ownership | string | – | Filters results by ownership relationship. Omitting this parameter returns all accessible queues, while specifying a value limits results to queues owned by the user or shared with them by others. |
| unnamed | boolean | – | When set to true, returns both named and unnamed queues. By default, only named queues are included in the results. |
No output schema declared.
No examples provided.
list_schedules List Schedules ~119
Retrieves a paginated list of schedules created by the user. Results are sorted by creation date ascending by default, with a maximum of 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, sorts the returned schedules by creation date in descending order instead of the default ascending order. |
| limit | number | – | Maximum number of schedules to return in a single request, capped at 1000. |
| offset | number | – | Number of schedules to skip from the beginning of the result set, used for paginating through records. |
No output schema declared.
No examples provided.
list_store_actors List Store Actors ~262
Retrieves the list of publicly available Actors from the Apify Store, with support for keyword search, filtering, and sorting. Returns up to 1,000 results and supports pagination.
| Name | Type | Req | Description |
|---|---|---|---|
| allowsAgenticUsers | boolean | – | When true, restricts results to Actors that permit agentic users; when false, restricts results to Actors that do not permit agentic users. |
| category | string | – | Filters results to only include Actors belonging to the specified category. |
| limit | number | – | Maximum number of Actors to return in a single response. Accepts values up to 1,000. |
| offset | number | – | Number of Actors to skip from the beginning of the result set, used for paginating through results. |
| pricingModel | string | – | Filters results to only include Actors with the specified pricing model. Must be one of the supported pricing model values. |
| search | string | – | Keyword or phrase used to search Actors across their title, name, description, username, and readme fields. |
| sortBy | string | – | Field by which to sort the returned Actors. Supported values are relevance (default), popularity, newest, and lastUpdate. |
| username | string | – | Filters results to only include Actors published by the specified username. |
No output schema declared.
No examples provided.
list_task_runs List Task Runs ~223
Retrieve a paginated list of runs for a specific actor task, including essential metadata for each run. Results can be filtered by status and sorted ascending or descending by start time.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the actor task, either as a task ID or a tilde-separated combination of the owner's username and task name. |
| desc | boolean | – | When set to true, sorts runs by their start time in descending order (newest first). By default, runs are returned in ascending order. |
| limit | number | – | Maximum number of runs to return in a single response. Accepts values between 1 and 1000, defaulting to 1000. |
| offset | number | – | Number of runs to skip from the beginning of the result set, used for paginating through results. Defaults to 0. |
| status | string | – | Filters results to only runs matching the specified status or comma-separated list of statuses. Valid statuses follow the Apify actor run lifecycle (e.g., SUCCEEDED, FAILED, RUNNING). |
No output schema declared.
No examples provided.
list_task_webhooks List Task Webhooks ~190
Retrieves a paginated list of webhooks associated with a specific Actor task. Results are sorted by creation date and capped at 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the Actor task, either as a plain task ID or in tilde-separated format combining the owner's username and task name. |
| desc | boolean | – | When set to true, reverses the sort order so that the most recently created webhooks appear first. By default, results are sorted by creation date in ascending order. |
| limit | number | – | Maximum number of webhooks to return in a single response. Accepts values between 1 and 1000, with 1000 as both the default and upper limit. |
| offset | number | – | Number of webhooks to skip from the beginning of the result set, used for paginating through records. Defaults to 0. |
No output schema declared.
No examples provided.
list_tasks List Tasks ~127
Retrieves a paginated list of all actor tasks created or used by the authenticated user. Results are sorted by creation date and capped at 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, sorts tasks by creation date in descending order (newest first); defaults to ascending order (oldest first). |
| limit | number | – | Maximum number of tasks to return in a single response, up to a maximum of 1000. |
| offset | number | – | Number of tasks to skip from the beginning of the result set, used for paginating through large lists. |
No output schema declared.
No examples provided.
list_webhook_dispatches List Webhook Dispatches ~140
Retrieves a paginated list of webhook dispatches associated with the authenticated user. Results are sorted by creation date and capped at 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, sorts the returned records by the createdAt field in descending order (newest first). Defaults to ascending order. |
| limit | number | – | Maximum number of webhook dispatch records to return in a single response. Accepts values up to 1000, which is also the default. |
| offset | number | – | Number of records to skip from the beginning of the result set, used for paginating through results. Defaults to 0. |
No output schema declared.
No examples provided.
list_webhook_dispatches_by_webhook List Webhook Dispatches ~54
Retrieves the list of dispatch records for a specific webhook, showing its delivery history and execution events.
| Name | Type | Req | Description |
|---|---|---|---|
| webhookId | string | yes | The unique identifier of the webhook whose dispatch history you want to retrieve. |
No output schema declared.
No examples provided.
list_webhooks List Webhooks ~126
Retrieves a paginated list of webhooks created by the authenticated user. Results are sorted by creation date and capped at 1000 records per request.
| Name | Type | Req | Description |
|---|---|---|---|
| desc | boolean | – | When set to true, results are sorted by creation date in descending order (newest first); defaults to ascending order (oldest first). |
| limit | number | – | Maximum number of webhook records to return in a single request, with an upper bound of 1000. |
| offset | number | – | Number of records to skip from the beginning of the result set, used for paginating through results. |
No output schema declared.
No examples provided.
lock_queue_head_requests Lock Queue Head Requests ~193
Retrieves and locks a specified number of requests from the head of a request queue, preventing other clients or runs from accessing them for the duration of the lock period. Returns a flag indicating whether the queue has been accessed by multiple clients.
| Name | Type | Req | Description |
|---|---|---|---|
| clientKey | string | – | A unique string identifier (1–32 characters) representing the calling client, used to detect whether the queue is being accessed by multiple distinct clients. Omitting this value causes the system to… |
| limit | number | – | The maximum number of requests to retrieve from the head of the queue, between 1 and 25. |
| lockSecs | number | yes | The duration in seconds for which the retrieved requests will be locked and unavailable to other clients or runs. |
| queueId | string | yes | The unique identifier of the request queue, either as a queue ID or in the format username~queue-name. |
No output schema declared.
No examples provided.
metamorph_run Metamorph Actor Run ~143
Transforms an active Actor run into a run of a different Actor with new input, seamlessly handing off work without creating a new run. The original run's default storages are preserved and the new input is stored in the same key-value store.
| Name | Type | Req | Description |
|---|---|---|---|
| build | string | – | Specifies which build of the target Actor to use, either as a build tag or build number. Defaults to the build defined in the target Actor's default run configuration (typically `latest`). |
| runId | string | yes | The unique identifier of the Actor run to be transformed. |
| targetActorId | string | yes | The unique identifier of the target Actor that this run should be transformed into. |
No output schema declared.
No examples provided.
prolong_request_lock Prolong Request Lock ~205
Extends the lock duration on a specific request in a queue, preventing other clients from acquiring it. Only the client that originally locked the request can prolong its lock.
| Name | Type | Req | Description |
|---|---|---|---|
| clientKey | string | – | A unique string identifier (1–32 characters) representing the client accessing the queue. Must match the client key used when the request was originally locked in order to prolong or delete the lock. |
| forefront | string | – | Controls where the request is placed in the queue after its lock expires — set to true to move it to the front of the queue, or false to place it at the end. |
| lockSecs | number | yes | The number of seconds to extend the lock duration from the current time. Must be a positive value. |
| queueId | string | yes | The unique identifier of the request queue, either as a queue ID or in the format username~queue-name. |
| requestId | string | yes | The unique identifier of the request whose lock you want to prolong. |
No output schema declared.
No examples provided.
put_store_record Put Store Record ~154
Stores a value under a specific key in a key-value store, with the content type defined by the Content-Type header. Supports Gzip, Deflate, and Brotli compression via the Content-Encoding header to reduce payload size and improve upload speed.
| Name | Type | Req | Description |
|---|---|---|---|
| body | object | – | The value to store in the record; any data type or structure is supported, with the content type specified via the Content-Type request header. |
| recordKey | string | yes | The key under which the value will be stored; must be unique within the store and is used to retrieve the record later. |
| storeId | string | yes | The unique identifier of the key-value store, either as a store ID or in the format username~store-name. |
No output schema declared.
No examples provided.
reboot_actor_run Reboot Actor Run ~85
Reboots a currently running Actor run by restarting its container, returning the updated run details. Only runs with a RUNNING status can be rebooted; any data not persisted to a key-value store, dataset, or request queue will be lost.
| Name | Type | Req | Description |
|---|---|---|---|
| runId | string | yes | The unique identifier of the Actor run to reboot. The run must currently have a RUNNING status. |
No output schema declared.
No examples provided.
resurrect_actor_run Resurrect Actor Run ~272
Restarts a finished Actor run (with status FINISHED, FAILED, ABORTED, or TIMED-OUT), resuming execution with the same storages and updating its status back to RUNNING. Optionally override the build, timeout, memory, or error-restart behavior from the original run.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The Actor's unique ID or a tilde-separated combination of the owner's username and Actor name identifying which Actor the run belongs to. |
| build | string | – | The Actor build to use for the resurrected run, specified as a build tag or build number. Defaults to the exact build version used when the run originally started, not the current resolution of any t… |
| memory | number | – | Memory allocated to the resurrected run in megabytes; must be a power of 2 and at least 128 MB. Defaults to the memory limit from the original run. |
| restartOnError | boolean | – | Whether the resurrected run should automatically restart if it encounters a failure. Defaults to the same setting used in the original run. |
| runId | string | yes | The unique ID of the finished Actor run to resurrect. |
| timeout | number | – | Maximum duration the resurrected run is allowed to execute, in seconds. Defaults to the timeout value from the original run. |
No output schema declared.
No examples provided.
resurrect_run Resurrect Run ~366
Restarts a finished Actor run (with status FINISHED, FAILED, ABORTED, or TIMED-OUT) by restarting its container with the same storages, updating its status back to RUNNING. Optionally override the build, timeout, memory, and cost limits used for the resurrected run.
| Name | Type | Req | Description |
|---|---|---|---|
| build | string | – | The Actor build to use for the resurrected run, specified as a build tag (e.g. 'latest') or a build number. If omitted, the run restarts with the exact build version it originally executed, even if a… |
| maxItems | number | – | Maximum number of dataset items that will be charged for pay-per-result Actors; does not cap the actual items returned, only the billable count. Accessible inside the Actor via the ACTOR_MAX_PAID_DAT… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the resurrected run, intended for pay-per-event Actors to cap charges to your subscription. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD enviro… |
| memory | number | – | Memory allocated to the resurrected run in megabytes; must be a power of 2 and at least 128 MB. If omitted, the memory limit from the original run is used. |
| restartOnError | boolean | – | Whether the resurrected run should automatically restart if it encounters a failure. If omitted, the setting from the original run is preserved. |
| runId | string | yes | The unique identifier of the Actor run to resurrect. |
| timeout | number | – | Maximum duration the resurrected run is allowed to execute, in seconds. If omitted, the timeout from the original run is used. |
No output schema declared.
No examples provided.
run_actor Run Actor ~513
Starts an Actor run asynchronously and immediately returns a Run object without waiting for completion. Pass input data as the request body and use the returned run ID or defaultDatasetId to retrieve results later.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique ID of the Actor, or a tilde-separated combination of the owner's username and Actor name. |
| body | object | – | The input payload passed to the Actor as INPUT, typically a JSON object. The Content-Type header of the request is forwarded alongside this body. |
| build | string | – | The specific Actor build to execute, specified as either a build tag or a build number. Defaults to the build defined in the Actor's configuration, typically the latest tag. |
| forcePermissionLevel | string | – | Overrides the Actor's default permission level for this run only, useful for testing restricted or elevated access scenarios without permanently changing the Actor's configuration. |
| maxItems | number | – | Maximum number of dataset items that will be billed for pay-per-result Actors. Does not cap the number of items returned — only limits charges. Accessible inside the Actor via the ACTOR_MAX_PAID_DATA… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the run, intended for pay-per-event Actors to cap charges. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Maximum RAM allocated to the run, in megabytes. Must be a power of 2 and at least 128 MB. Overrides the memory limit configured in the Actor's settings. |
| restartOnError | boolean | – | Whether the run should automatically restart if it encounters a failure. |
| timeout | number | – | Maximum duration the run is allowed to execute before being stopped, in seconds. Overrides the timeout configured in the Actor's settings. |
| waitForFinish | number | – | Number of seconds the server will wait for the run to finish before returning a response, between 0 and 60. If the run completes within this window, the response will reflect a terminal status such a… |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
No output schema declared.
No examples provided.
run_actor_sync Run Actor Synchronously ~463
Runs a specific Actor synchronously, passing the request body as INPUT, and returns the Actor's OUTPUT from its default key-value store. If the Actor run exceeds 300 seconds, the response will return a 408 timeout status.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor to run, either as an Actor ID or a tilde-separated owner username and Actor name combination. |
| body | object | – | The input payload passed to the Actor as its INPUT record. The Content-Type header of the request is forwarded alongside this body, typically as application/json. |
| build | string | – | The specific Actor build to execute, specified as either a build tag or build number. Defaults to the build defined in the Actor's configuration, typically the latest tag. |
| maxItems | number | – | Maximum number of dataset items that will be charged for pay-per-result Actors. Does not cap the number of items returned, only the number billed. Accessible inside the Actor via the ACTOR_MAX_PAID_D… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the run, useful for limiting charges on pay-per-event Actors. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Memory allocated for the Actor run, in megabytes. Must be a power of 2 with a minimum of 128 MB. Overrides the memory limit defined in the Actor's configuration. |
| outputRecordKey | string | – | The key of the record from the run's default key-value store to return in the response. Defaults to OUTPUT if not specified. |
| restartOnError | boolean | – | Whether the Actor run should automatically restart if it encounters a failure. |
| timeout | number | – | Maximum duration the Actor run is allowed to execute, in seconds. Overrides the timeout defined in the Actor's configuration. |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
No output schema declared.
No examples provided.
run_actor_sync_get_dataset_items Run Actor Synchronously and Get Dataset Items ~1,114
Runs a specific Actor synchronously without input and returns its dataset items directly in the response. The Actor must complete within 300 seconds; if it exceeds this limit or the connection breaks, a timeout error is returned.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor to run, either as an internal Actor ID or as a tilde-separated combination of the owner's username and Actor name. |
| attachment | boolean | – | When set to true, adds a Content-Disposition: attachment header to the response, prompting browsers to download the result as a file rather than render it inline. |
| bom | boolean | – | Controls whether a UTF-8 Byte Order Mark (BOM) is prepended to the response. By default, BOM is included for CSV and omitted for json, jsonl, xml, html, and rss. Set to true to force inclusion or fal… |
| build | string | – | Specifies which build of the Actor to execute, either by build tag or build number. Overrides the build defined in the Actor's saved configuration, which defaults to the latest tag. |
| delimiter | string | – | Single character used as the field delimiter in CSV output. Only applies when format is csv. Special characters should be URL-encoded (e.g., %09 for tab, %3B for semicolon). Defaults to a comma. |
| desc | boolean | – | When set to true, reverses the order of returned items so the most recently stored items appear first. By default, items are returned in insertion order. |
| fields | string | – | Comma-separated list of field names to include in each returned item, excluding all other fields. Output fields are ordered to match the order specified in this list. |
| flatten | string | – | Comma-separated list of fields whose nested object values should be flattened into dot-notation keys on the parent object. The original nested object is replaced by its flattened representation. |
| format | string | – | Output format for the returned dataset items. Supported values are json, jsonl, csv, html, xlsx, xml, and rss. |
| limit | number | – | Maximum number of dataset items to include in the response. When omitted, all available items are returned. |
| maxItems | number | – | Maximum number of dataset items that will be billed for pay-per-result Actors. Does not cap the number of items returned — only limits charges. Accessible inside the Actor via the ACTOR_MAX_PAID_DATA… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD that may be charged for this run, intended for pay-per-event Actors. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Maximum RAM the Actor run may use, in megabytes. Must be a power of 2 and at least 128 MB. Overrides the memory limit defined in the Actor's saved configuration. |
| offset | number | – | Number of dataset items to skip from the beginning of the result set before returning data. Useful for pagination. |
| omit | string | – | Comma-separated list of field names to exclude from each returned item. All other fields are retained. |
| restartOnError | boolean | – | When enabled, the Actor run will automatically restart if it encounters a failure, rather than terminating in an error state. |
| simplified | boolean | – | When set to true, applies preset query parameters fields=url,pageFunctionResult,errorInfo and unwind=pageFunctionResult to emulate the simplified output format of the legacy Apify Crawler. Not recomm… |
| skipEmpty | boolean | – | When set to true, items with no fields or all-null values are excluded from the output. Note that the total number of returned items may be less than the specified limit when this is enabled. |
| skipFailedPages | boolean | – | When set to true, excludes all items that contain an errorInfo property from the output. Provided for compatibility with legacy Apify Crawler API v1 behavior. Not recommended for new integrations. |
| skipHeaderRow | boolean | – | When set to true, omits the header row from csv-formatted output. Only applies when format is csv. |
| skipHidden | boolean | – | When set to true, excludes fields whose names begin with the # character from the output. |
| timeout | number | – | Maximum duration the Actor run is allowed to execute before being forcibly stopped, in seconds. Overrides the timeout defined in the Actor's saved configuration. |
| unwind | string | – | Comma-separated list of fields to unwind, processed in the specified order. Array fields produce one record per element merged with the parent; object fields are merged directly into the parent. Item… |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
| xmlRoot | string | – | Overrides the name of the root XML element in xml-formatted output. Only applies when format is xml. |
| xmlRow | string | – | Overrides the name of the element wrapping each individual record in xml-formatted output. Only applies when format is xml. |
No output schema declared.
No examples provided.
run_actor_sync_get_dataset_items_with_input Run Actor Synchronously and Get Dataset Items ~905
Runs a specific Actor synchronously with the provided input payload and returns the resulting dataset items directly in the response. Supports the same output formatting and filtering options as the Get Dataset Items endpoint; times out with HTTP 408 if the Actor run exceeds 300 seconds.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique ID of the Actor, or a tilde-separated combination of the owner's username and Actor name. |
| body | object | – | The input payload passed to the Actor as its INPUT, with the request's Content-Type header forwarded alongside it. Typically a JSON object. |
| build | string | – | The specific Actor build to execute, specified as either a build tag or a build number. Defaults to the build configured on the Actor, typically the latest tag. |
| delimiter | string | – | Single character used as the field delimiter in CSV output; only applicable when format is csv. URL-encode special characters as needed. Defaults to a comma. |
| desc | boolean | – | When set to true, reverses the order of returned items. By default, items are returned in the order they were stored. |
| fields | string | – | Comma-separated list of field names to include in each output record, excluding all other fields. Output fields are ordered according to the order specified in this list. |
| flatten | string | – | Comma-separated list of fields whose nested object values should be flattened into dot-notation keys on the parent object. The original nested object is replaced by its flattened representation. |
| format | string | – | Output format for the returned dataset items. Accepted values are json, jsonl, csv, html, xlsx, xml, and rss. Defaults to json. |
| limit | number | – | Maximum number of dataset items to include in the response. When omitted, all available items are returned. |
| maxItems | number | – | Maximum number of dataset items that will be charged for pay-per-result Actors. Does not cap the number of items returned — only limits billing. Accessible inside the Actor via the ACTOR_MAX_PAID_DAT… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the run, intended for pay-per-event Actors to cap charges. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Memory allocated to the Actor run in megabytes. Must be a power of 2 with a minimum of 128 MB. Defaults to the memory limit configured on the Actor. |
| offset | number | – | Number of dataset items to skip from the beginning of the result set before returning data. Defaults to 0. |
| omit | string | – | Comma-separated list of field names to exclude from each output record. All other fields are retained. |
| restartOnError | boolean | – | When set to true, the Actor run will automatically restart if it encounters a failure. |
| skipEmpty | boolean | – | When set to true, items with no fields or all-null values are excluded from the output. Note that the total number of returned items may be less than the specified limit when this option is active. |
| skipHeaderRow | boolean | – | When set to true, omits the header row from csv-formatted output. |
| skipHidden | boolean | – | When set to true, fields whose names begin with the # character are excluded from the output. |
| timeout | number | – | Maximum duration the Actor run is allowed to execute before being terminated, in seconds. Defaults to the timeout configured on the Actor itself. |
| unwind | string | – | Comma-separated list of fields to unwind, processed in the specified order. Array fields produce one record per element merged with the parent; object fields are merged directly into the parent. Item… |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
| xmlRoot | string | – | Overrides the name of the root XML element in xml-formatted output. Defaults to items. |
| xmlRow | string | – | Overrides the name of the element wrapping each individual record in xml-formatted output. Defaults to item. |
No output schema declared.
No examples provided.
run_actor_sync_no_input Run Actor Synchronously ~445
Runs a specific Actor synchronously without input and returns its output directly in the response. The run must complete within 300 seconds; if it exceeds this limit or the connection breaks, a timeout error is returned.
| Name | Type | Req | Description |
|---|---|---|---|
| actorId | string | yes | The unique identifier of the Actor to run, either as an Actor ID or a tilde-separated combination of the owner's username and Actor name. |
| build | string | – | Specifies which build of the Actor to execute, provided as either a build tag or a build number. Defaults to the build defined in the Actor's configuration, typically the latest tag. |
| maxItems | number | – | Maximum number of dataset items that will be charged for pay-per-result Actors; does not cap the actual items returned, only the billing ceiling. Accessible inside the Actor via the ACTOR_MAX_PAID_DA… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the run, useful for capping charges on pay-per-event Actors. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Memory allocated for the run in megabytes; must be a power of 2 with a minimum of 128. If omitted, the memory limit from the Actor's saved configuration is used. |
| outputRecordKey | string | – | The key of the record from the run's default key-value store to return in the response. Defaults to OUTPUT if not specified. |
| restartOnError | boolean | – | When set to true, the run will automatically restart if it encounters a failure. Defaults to false if not specified. |
| timeout | number | – | Maximum duration the run is allowed to execute, in seconds. If omitted, the timeout defined in the Actor's saved configuration is used. |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
No output schema declared.
No examples provided.
run_task Run Task ~497
Starts an Actor task run asynchronously and immediately returns a run object without waiting for completion. Optionally override the task's input configuration via the request body, and use the returned run ID to poll for results or fetch dataset output.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the task to run, either as a task ID or a tilde-separated string combining the owner's username and task name. |
| body | object | – | JSON object containing input properties to override the task's default input configuration. Any properties not included here will fall back to the task's or Actor's default values. |
| build | string | – | The specific Actor build to execute, specified as either a build tag or a build number. Overrides the build defined in the task's configuration, which defaults to latest. |
| maxItems | number | – | Maximum number of dataset items that will be billed for pay-per-result Actors. Does not cap the number of items returned — only limits charges. Accessible inside the Actor via the ACTOR_MAX_PAID_DATA… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the run, useful for capping charges on pay-per-event Actors. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Maximum RAM allocated to the run, in megabytes. Must be a power of 2 with a minimum of 128. Overrides the memory limit defined in the task's configuration. |
| restartOnError | boolean | – | Whether the run should automatically restart if it encounters a failure. Defaults to false. |
| timeout | number | – | Maximum duration the run is allowed to execute before being terminated, in seconds. Overrides the timeout defined in the task's configuration. |
| waitForFinish | number | – | Number of seconds the server will wait for the run to finish before returning a response. Accepts values from 0 to 60; if the run completes within this window the response will reflect a terminal sta… |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
No output schema declared.
No examples provided.
run_task_sync Run Task Synchronously ~481
Runs an Actor task synchronously and returns its output directly in the response. The task must complete within 300 seconds; optionally, you can override the task's default input by providing a JSON payload.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the Actor task to run, either as a task ID or a tilde-separated combination of the owner's username and task name. |
| body | object | – | A JSON object used to override specific input fields defined in the Actor task configuration. Any fields not included here will fall back to the task's default values. Requires the Content-Type heade… |
| build | string | – | The specific Actor build to execute, specified as either a build tag or a build number. Defaults to the build defined in the task's configuration, typically the latest tag. |
| maxItems | number | – | Maximum number of dataset items that will be billed for pay-per-result Actors. Does not cap the number of items returned, only the number charged. Accessible inside the Actor via the ACTOR_MAX_PAID_D… |
| maxTotalChargeUsd | number | – | Maximum total cost in USD allowed for the run, intended for pay-per-event Actors to cap charges. Accessible inside the Actor via the ACTOR_MAX_TOTAL_CHARGE_USD environment variable. |
| memory | number | – | Memory allocated to the run, in megabytes. Must be a power of 2 with a minimum of 128 MB. Overrides the memory limit defined in the task's configuration. |
| outputRecordKey | string | – | The key of the record in the run's default key-value store to return in the response body. Defaults to OUTPUT if not specified. |
| restartOnError | boolean | – | Whether the run should automatically restart if it encounters a failure. Defaults to false. |
| timeout | number | – | Maximum duration the run is allowed to execute before being timed out, in seconds. Overrides the timeout defined in the task's configuration. |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
No output schema declared.
No examples provided.
run_task_sync_and_get_dataset_items Run Task Synchronously and Get Dataset Items ~1,033
Synchronously runs a specific actor task and returns its dataset items directly in the response. The task must complete within 300 seconds; if it exceeds this limit the request times out, though the underlying run continues executing.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the actor task to run, either as a task ID or a tilde-separated combination of the owner's username and task name. |
| attachment | boolean | – | When set to true, adds a Content-Disposition: attachment header to the response, prompting browsers to download the result as a file rather than render it inline. |
| bom | boolean | – | Controls inclusion of the UTF-8 Byte Order Mark (BOM) in the response. CSV files include the BOM by default; json, jsonl, xml, html, and rss do not. Set to true to force inclusion or false to force e… |
| build | string | – | The actor build to execute, specified as either a build tag or a build number. If omitted, the build defined in the task's saved configuration (typically 'latest') is used. |
| delimiter | string | – | Field delimiter character used when format is csv. Special characters should be URL-encoded (e.g., %09 for tab, %3B for semicolon). Defaults to a comma. |
| desc | boolean | – | When set to true, reverses the order of returned items so the most recently stored items appear first. By default items are returned in insertion order. |
| fields | string | – | Comma-separated list of field names to include in each returned item, excluding all other fields. Output fields are ordered to match the order specified in this list. |
| flatten | string | – | Comma-separated list of fields whose nested object values should be flattened into dot-notation keys on the parent object. The original nested object is replaced by its flattened representation. |
| format | string | – | Output format for the returned dataset items. Supported values are: json, jsonl, csv, html, xlsx, xml, and rss. Defaults to json if not specified. |
| limit | number | – | Maximum number of items to include in the response. When omitted, all available items are returned without a cap. |
| maxItems | number | – | Maximum number of dataset items that will be charged for pay-per-result actors. Does not cap the number of items returned — only limits billing. Accessible inside the actor run via the ACTOR_MAX_PAID… |
| memory | number | – | Memory allocated to the run in megabytes. Must be a power of 2 and at least 128 MB. If omitted, the memory limit from the task's saved configuration is used. |
| offset | number | – | Number of items to skip from the beginning of the dataset before returning results. Useful for pagination. Defaults to 0. |
| omit | string | – | Comma-separated list of field names to exclude from each returned item. All other fields are retained in the output. |
| simplified | boolean | – | When set to true, automatically applies fields=url,pageFunctionResult,errorInfo and unwind=pageFunctionResult to emulate the legacy Apify Crawler simplified output format. Not recommended for new int… |
| skipEmpty | boolean | – | When set to true, items with no fields or empty values are excluded from the output. Note that the total number of returned items may be less than the specified limit when this is enabled. |
| skipFailedPages | boolean | – | When set to true, items containing an errorInfo property are excluded from the output. Provided for backward compatibility with legacy Apify Crawler integrations and not recommended for new integrati… |
| skipHeaderRow | boolean | – | When set to true, omits the header row from csv output. Only applies when format is csv. |
| skipHidden | boolean | – | When set to true, excludes fields whose names begin with the '#' character from the output. |
| timeout | number | – | Maximum duration in seconds the run is allowed to execute before being timed out. If omitted, the timeout defined in the task's saved configuration is used. |
| unwind | string | – | Comma-separated list of fields to unwind, processed in the order specified. Array fields produce one record per element merged with the parent; object fields are merged directly into the parent. Item… |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
| xmlRoot | string | – | Overrides the name of the root XML element when format is xml. Defaults to 'items'. |
| xmlRow | string | – | Overrides the name of the element wrapping each individual record when format is xml. Defaults to 'item'. |
No output schema declared.
No examples provided.
run_task_sync_get Run Task Synchronously ~387
Runs a specific actor task synchronously and returns its output directly in the response. The task must complete within 300 seconds; if it exceeds this limit or the connection drops, the request fails but the underlying run continues.
| Name | Type | Req | Description |
|---|---|---|---|
| actorTaskId | string | yes | The unique identifier of the task to run, either as a task ID or a tilde-separated combination of the owner's username and task name. |
| build | string | – | The Actor build to execute, specified as either a build tag or a build number. If omitted, the build defined in the task's saved configuration (typically 'latest') is used. |
| maxItems | number | – | Maximum number of dataset items that will be billed for pay-per-result Actors; does not cap the actual items returned, only the charge. Applies exclusively to pay-per-result Actors and is exposed ins… |
| memory | number | – | Memory allocated to the run in megabytes; must be a power of 2 and at least 128 MB. If omitted, the memory limit from the task's saved configuration is used. |
| outputRecordKey | string | – | The key of the record in the run's default key-value store whose value will be returned as the response body. Defaults to 'OUTPUT' if not specified. |
| timeout | number | – | Maximum duration in seconds the run is allowed to execute before being timed out. If omitted, the timeout defined in the task's saved configuration is used. |
| webhook_event_types | array | – | List of event types to trigger the webhook. Common values: 'ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED', 'ACTOR.RUN.ABORTED', 'ACTOR.RUN.TIMED_OUT'. |
| webhook_request_url | string | – | URL that will receive the webhook POST request when the event fires. |
No output schema declared.
No examples provided.
What is the com.mcparmory/apify MCP server?
com.mcparmory/apify is an MCP server listed in the public MCP registry as com.mcparmory/apify. Build, deploy, and run web scraping and automation actors in the cloud. This page covers its PyPI package (mcparmory-apify).
Is the com.mcparmory/apify MCP server safe to use?
com.mcparmory/apify scores 75 out of 100 on VerifyMCP. We found no known CVEs affecting it as of 20 September 2026. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.
What tools does the com.mcparmory/apify MCP server expose?
com.mcparmory/apify exposes 112 tools: list_actors, create_actor, get_actor, update_actor, delete_actor, and 107 more. Their descriptions and schemas cost roughly 23,887 tokens of context every time the server is loaded.
Is the com.mcparmory/apify MCP server still maintained?
com.mcparmory/apify is still listed as active in the MCP registry. We last reached this channel on 20 September 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.