---
canonical_url: "https://docs.composio.dev/toolkits/parse_bot"
markdown_url: "https://docs.composio.dev/toolkits/parse_bot.md"
product: "platform"
version: null
last_updated: null
---

# Parse.bot

Parse.bot creates, manages, and executes site-specific scraping APIs from website URLs.

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `PARSE_BOT`
- **Version:** 00000000_00

## Tools

### Cancel API Build Task

**Slug:** `PARSE_BOT_CANCEL_API_BUILD_TASK`

Irreversibly cancel an in-flight API build or revision task; terminal tasks cannot be cancelled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the queued, running, or input-blocked task to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check API Updates

**Slug:** `PARSE_BOT_CHECK_API_UPDATES`

List new or changed canonical endpoints available to merge into a linked generated API without modifying it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the linked API build task to compare with its canonical API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create API from URL

**Slug:** `PARSE_BOT_CREATE_API_FROM_URL`

Start a persistent task that builds a callable API from a website URL; private builds and authenticated-site builds may require a paid plan or incur charges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public website URL from which Parse.bot should build an API. |
| `task` | string | No | Natural-language description of the data the generated API should retrieve. |
| `workspace` | boolean | No | Create the API in the team workspace; requires a Team-plan workspace. |
| `allow_auth` | boolean | No | Allow building for a login-required target site; requires a paid plan and prior disclaimer acceptance. |
| `contributes_to_marketplace` | boolean | No | Keep true to link to the shared canonical API and make the build free; false creates a permanently desynced private API and is charged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Generated GET Endpoint

**Slug:** `PARSE_BOT_EXECUTE_GENERATED_GET_ENDPOINT`

Execute one generated GET endpoint with its schema-defined query parameters. Each call consumes the endpoint's advertised Parse.bot credits and may access an external site. Login and authenticated-session endpoints are intentionally unsupported because their credentials must stay out of model context; inspect the generated OpenAPI document or MCP export first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parameters` | object | No | Endpoint-specific inputs to expand into query parameters. Names, types, and required fields must match the selected generated endpoint's OpenAPI input schema. |
| `scraper_id` | string | Yes | Generated scraper UUID from a build task, subscription, or fork. |
| `endpoint_name` | string | Yes | Exact generated GET endpoint name from the API's OpenAPI document, MCP export, or marketplace detail. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Generated POST Endpoint

**Slug:** `PARSE_BOT_EXECUTE_GENERATED_POST_ENDPOINT`

Execute one generated POST endpoint with its schema-defined JSON parameters. Each call consumes the endpoint's advertised Parse.bot credits and may cause endpoint-specific external effects. Login and authenticated-session endpoints are intentionally unsupported because their credentials must stay out of model context; inspect the generated OpenAPI document or MCP export before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parameters` | object | No | Endpoint-specific JSON body. Names, types, and required fields must match the selected generated endpoint's OpenAPI input schema. Executing the endpoint consumes its advertised Parse.bot credits and may cause external effects. Login and authenticated-session endpoints are not supported because their credentials must stay out of model context. |
| `scraper_id` | string | Yes | Generated scraper UUID from a build task, subscription, or fork. |
| `endpoint_name` | string | Yes | Exact generated POST endpoint name from the API's OpenAPI document, MCP export, or marketplace detail. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export API as MCP Tools

**Slug:** `PARSE_BOT_EXPORT_API_AS_MCP_TOOLS`

Export a completed generated API as MCP tool definitions, preserving each tool's dynamic input schema, execution metadata, and provider-reported price.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the completed API build task to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fork Marketplace API

**Slug:** `PARSE_BOT_FORK_MARKETPLACE_API`

Create a persistent private copy of a marketplace API. The copy is permanently desynchronized from the canonical API, may require a paid tier or incur charges, and cannot be deleted through the documented API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `marketplace_api_id` | string | Yes | Marketplace API UUID to fork. This creates a persistent private copy that is permanently desynchronized from the canonical API, may require a paid tier or incur charges, and cannot be deleted through the documented API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Active Scraper Task

**Slug:** `PARSE_BOT_GET_ACTIVE_SCRAPER_TASK`

Get the active revision or extension task for a generated Parse.bot scraper, returning null when none is in flight.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scraper_id` | string | Yes | UUID of the generated scraper whose active task should be checked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Build Task

**Slug:** `PARSE_BOT_GET_API_BUILD_TASK`

Get full details, progress, prompts, errors, and the generated API specification for one Parse.bot build or revision task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the API build or revision task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API OpenAPI Document

**Slug:** `PARSE_BOT_GET_API_OPENAPI_DOCUMENT`

Return the complete OpenAPI 3.1 document for a callable generated API, optionally pinned to an available snapshot version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | integer | No | Available API snapshot version to retrieve; omit for the current document. |
| `scraper_id` | string | Yes | UUID of the generated scraper whose OpenAPI document to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API SDK Example

**Slug:** `PARSE_BOT_GET_API_SDK_EXAMPLE`

Get Parse SDK example code and endpoint names for a completed generated API, or null when no example is available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the completed API build task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Marketplace API

**Slug:** `PARSE_BOT_GET_MARKETPLACE_API`

Get a public marketplace API listing with its callable endpoint schemas, prices, versions, authentication requirements, and current subscription state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `marketplace_api_id` | string | Yes | Marketplace API UUID returned by a marketplace search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API Build Tasks

**Slug:** `PARSE_BOT_LIST_API_BUILD_TASKS`

Return one page of API build and revision tasks for the connected Parse.bot account, optionally filtered by status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum tasks to return in this page (1-100). |
| `status` | string ("queued" | "running" | "completed" | "failed" | "needs_input") | No | Return only tasks in this lifecycle status. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API Revisions

**Slug:** `PARSE_BOT_LIST_API_REVISIONS`

List all revision child tasks for a Parse.bot API build task, including exact-total metadata when provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the parent API build task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge API Updates

**Slug:** `PARSE_BOT_MERGE_API_UPDATES`

Merge selected canonical endpoint updates into an existing generated API, persistently changing its callable endpoint set or code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the linked API build task to update. |
| `endpoints` | array | Yes | Exact endpoint names returned by Check API Updates to merge from the canonical API. Provide at least one name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview API Endpoint Update

**Slug:** `PARSE_BOT_PREVIEW_API_ENDPOINT_UPDATE`

Execute a pending canonical endpoint update as a preview without merging it. The preview invokes an endpoint with dynamically unknown effects, may change external or session state, and may consume Parse.bot credits or incur charges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the API build task with a pending canonical update. |
| `parameters` | object | No | Endpoint-specific preview inputs matching that endpoint's generated schema. Omit when the endpoint accepts no inputs. |
| `endpoint_name` | string | Yes | Exact pending endpoint name returned by Check API Updates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Respond to API Build Prompt

**Slug:** `PARSE_BOT_RESPOND_TO_API_BUILD_PROMPT`

Submit a pre-encrypted response to an API build task waiting for user input. The AES-GCM/RSA-OAEP envelope must be created outside model context from the task prompt's public key; never provide plaintext credentials or 2FA values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iv` | string | Yes | Base64 12-byte AES-GCM initialization vector produced outside model context. |
| `task_id` | string | Yes | UUID of a task currently in needs_input status. |
| `ciphertext` | string | Yes | Base64 AES-256-GCM ciphertext containing the prompt outcome and values. Never put plaintext credentials or 2FA values in this field. |
| `request_id` | string | Yes | Prompt request ID from the task's user_input_prompt. It binds the encrypted response to the current short-lived prompt. |
| `encrypted_key` | string | Yes | Base64 RSA-OAEP-wrapped AES-256 key produced outside model context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revise API

**Slug:** `PARSE_BOT_REVISE_API`

Start a persistent revision task for a completed API. By default the API remains linked to the shared marketplace canonical and the revision is free; choosing a private revision permanently desynchronizes it and incurs charges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the completed API build task to revise. |
| `revision` | string | Yes | Natural-language description of the changes to make to the generated API. |
| `contributes_to_marketplace` | boolean | No | Keep true to remain linked to the shared marketplace canonical and make the revision free. False permanently desynchronizes the API, makes it private, and causes the revision to be charged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rollback API Update Merge

**Slug:** `PARSE_BOT_ROLLBACK_API_UPDATE_MERGE`

Irreversibly restore a generated API to its state before its most recent canonical update merge. Only the latest merge can be rolled back.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | UUID of the API build task whose most recent update merge should be rolled back. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Marketplace APIs

**Slug:** `PARSE_BOT_SEARCH_MARKETPLACE_APIS`

Return one page of public Parse.bot marketplace APIs filtered by text, category, country, and sort order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("top" | "recent" | "name") | No | Order results by popularity, recency, or name. |
| `limit` | integer | No | Maximum marketplace APIs to return in this page (1-200). |
| `query` | string | No | Text to match against API names, descriptions, and endpoint metadata. |
| `country` | string | No | ISO 3166-1 alpha-2 country code to filter by. |
| `category` | string | No | Marketplace category slug to require. |
| `semantic` | boolean | No | Use semantic matching in addition to lexical search. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Marketplace Endpoints

**Slug:** `PARSE_BOT_SEARCH_MARKETPLACE_ENDPOINTS`

Search individual callable endpoints across public marketplace APIs and return matching API and endpoint groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Capability or data to search for across marketplace endpoint names and descriptions. |
| `country` | string | No | ISO 3166-1 alpha-2 country code to use for region-aware ranking. |
| `api_limit` | integer | No | Maximum matching API listings to return (1-20). |
| `endpoint_limit` | integer | No | Maximum matching individual endpoints to return (1-40). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Subscribe to Marketplace API

**Slug:** `PARSE_BOT_SUBSCRIBE_TO_MARKETPLACE_API`

Create a persistent, pinned, sync-eligible copy of a public marketplace API in the connected account. Parse.bot provides no documented unsubscribe or delete endpoint for removing the created copy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `marketplace_api_id` | string | Yes | Marketplace API UUID to copy into the connected account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
