Skip to main content
Apify logo

​
Overview

Add Apify to any ModuleX agent or workflow. Web scraping, automation, and data extraction platform via the Apify REST API (api.apify.com/v2).
Categories: Web Search & Scraping · Developer Tools & Infrastructure · Automation · Auth: API Token · Actions: 7

​
Authentication

​
API Token

Authenticate using your Apify API token
1

Step 1

Go to https://console.apify.com/account/integrations
2

Step 2

Copy your Personal API token

​
Required Credentials

FieldDescriptionRequiredFormat
API TokenYour Apify API token from the Integrations pageYesapify_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
actor_id
string
required
The Actor ID or tilde-separated owner/name identifier (e.g. ‘apify~web-scraper’)
​
run_input
object
JSON object with the input for the Actor run
​
build_tag
string
Specifies the Actor build to run. If not provided, the default build is used.
​
run_asynchronously
boolean
If true, returns immediately with run metadata. If false, waits for completion. (Default: true)
​
timeout
integer
Optional timeout for the run, in seconds
​
memory
integer
Memory limit for the run, in megabytes (power of 2, min 128)
​
max_items
integer
The maximum number of items that the Actor run should return

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "run_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run Id"
    },
    "act_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Act Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Started At"
    },
    "dataset_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Dataset Id"
    },
    "key_value_store_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key Value Store Id"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "RunActorOutput",
  "type": "object"
}

​
Parameters

​
task_id
string
required
The ID of the task to run
​
override_input
string
Optional JSON string to override the default input for the task run
​
timeout
integer
Optional timeout for the run, in seconds
​
memory
integer
Memory limit for the run, in megabytes (power of 2, min 128)
​
build
string
Specifies the Actor build to run (build tag or number)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "run_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run Id"
    },
    "act_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Act Id"
    },
    "task_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Started At"
    },
    "dataset_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Dataset Id"
    },
    "key_value_store_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key Value Store Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "RunTaskOutput",
  "type": "object"
}

​
Parameters

​
task_id
string
required
The ID of the task to run
​
timeout
integer
Optional timeout for the run, in seconds
​
memory
integer
Memory limit for the run, in megabytes (power of 2, min 128)
​
build
string
Specifies the Actor build to run (build tag or number)
​
limit
integer
The maximum number of dataset items to return (Default: 100)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "run_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run Id"
    },
    "act_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Act Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Started At"
    },
    "finished_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Finished At"
    },
    "dataset_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Dataset Id"
    },
    "items": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Items",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "RunTaskSynchronouslyOutput",
  "type": "object"
}

​
Parameters

​
dataset_id
string
required
The ID of the dataset to retrieve items from
​
offset
integer
The number of records to skip before returning results (Default: 0)
​
limit
integer
The maximum number of items to return (Default: 100)
​
clean
boolean
Return only non-empty items and skip hidden fields (fields starting with #)
​
fields
string
Comma-separated list of field names to include in results

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Items",
      "type": "array"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetDatasetItemsOutput",
  "type": "object"
}

​
Parameters

​
key_value_store_id
string
required
The ID of the key-value store
​
key
string
required
The key of the record to retrieve

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "content_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Type"
    },
    "data": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetKvsRecordOutput",
  "type": "object"
}

​
Parameters

​
url
string
required
The URL of the web page to scrape
​
crawler_type
string
Crawling engine: ‘playwright:firefox’ (stealthy), ‘playwright:chrome’, ‘cheerio’ (fast, static only), ‘playwright:adaptive’ (auto-switches) (Default: playwright:firefox)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url"
    },
    "text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Text"
    },
    "html": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Html"
    },
    "markdown": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Markdown"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScrapeSingleUrlOutput",
  "type": "object"
}

​
Parameters

​
key_value_store_id
string
required
The ID of the key-value store
​
key
string
required
The key of the record to create or update
​
value
string
required
The value to store. Valid JSON strings are stored as JSON; otherwise as plain text.

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "store_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Store Id"
    },
    "key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key"
    },
    "content_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Type"
    }
  },
  "required": [
    "success"
  ],
  "title": "SetKeyValueStoreRecordOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limits depend on Apify plan: Free tier has limited concurrent runs; paid plans scale to hundreds.
  • Actor runs are billed by compute units (CU) based on memory and duration.
  • Synchronous run endpoints have a default server timeout of 300 seconds.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Browserbase

Daytona

ServiceNow