Apify Integration — ModuleX AI

Field	Description	Required	Format
API Token	Your Apify API token from the Integrations page	Yes	`apify_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

run_actor — Run an Apify Actor and return the run metadata

Parameters

string

required

The Actor ID or tilde-separated owner/name identifier (e.g. ‘apify~web-scraper’)

object

JSON object with the input for the Actor run

string

Specifies the Actor build to run. If not provided, the default build is used.

boolean

If true, returns immediately with run metadata. If false, waits for completion. (Default: true)

integer

Optional timeout for the run, in seconds

integer

Memory limit for the run, in megabytes (power of 2, min 128)

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

run_task — Start an Apify task and return its run metadata

Parameters

string

required

The ID of the task to run

string

Optional JSON string to override the default input for the task run

integer

Optional timeout for the run, in seconds

integer

Memory limit for the run, in megabytes (power of 2, min 128)

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

run_task_synchronously — Run an Apify task synchronously and return its dataset items

Parameters

string

required

The ID of the task to run

integer

Optional timeout for the run, in seconds

integer

Memory limit for the run, in megabytes (power of 2, min 128)

string

Specifies the Actor build to run (build tag or number)

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

get_dataset_items — Retrieve items from an Apify dataset

Parameters

string

required

The ID of the dataset to retrieve items from

integer

The number of records to skip before returning results (Default: 0)

integer

The maximum number of items to return (Default: 100)

boolean

Return only non-empty items and skip hidden fields (fields starting with #)

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

get_kvs_record — Get a record from an Apify key-value store

Parameters

string

required

The ID of the key-value store

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

scrape_single_url — Scrape a single URL using Apify's Web Content Crawler and return its content

Parameters

string

required

The URL of the web page to scrape

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

set_key_value_store_record — Create or update a record in an Apify key-value store

Parameters

string

required

The ID of the key-value store

string

required

The key of the record to create or update

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

Using

Providers

Building

Tools

Apify Integration for AI Agents & Workflows

Overview

Authentication

API Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Browserbase

Daytona

ServiceNow

Links

​Overview

​Authentication

​API Token

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Browserbase

Daytona

ServiceNow

​Links

Overview

Authentication

API Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links