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

# Botster

Botster automates web data collection through configurable bots, job lifecycle management, and structured run results.

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

## Tools

### Calculate Bot Cost

**Slug:** `BOTSTER_CALCULATE_BOT_COST`

Calculate the credit price of one intended bot launch using the same input and bot-specific options, without launching the bot or spending credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | Main bot input exactly as intended for launch; Botster accepts a string or an array of strings depending on the bot. |
| `options` | object | No | Bot-specific option key/value pairs sent at the top level beside input, such as {"limit": 1}; names and value shapes vary by bot. |
| `bot_slug` | string | Yes | Bot identifier returned by LIST_BOTS, for example 'google-local-finder'. |

#### 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 |

### Delete Job

**Slug:** `BOTSTER_DELETE_JOB`

Permanently delete one Botster job. This destructive action cannot be undone, is not the same as archiving, and may remove access to the job's run history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Identifier of the job to permanently delete. |

#### 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 |

### Delete Run

**Slug:** `BOTSTER_DELETE_RUN`

Permanently delete one Botster data run and its stored results without deleting the entire job. This destructive operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Identifier of the data run to permanently delete. |

#### 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 Credit Balance

**Slug:** `BOTSTER_GET_CREDITS`

Return the connected Botster account's available credit balance; use this before launching or restarting credit-consuming work.

#### 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 Job

**Slug:** `BOTSTER_GET_JOB`

Get one job's status and data-run identifiers required to retrieve run results. The complete provider job object is returned without discarding bot-specific fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Job identifier returned by LAUNCH_BOT or LIST_JOBS. |

#### 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 Run Results

**Slug:** `BOTSTER_GET_RUN_RESULTS`

Return the complete bot-specific JSON for one data run identified from GET_JOB in the results field. The provider's result shape is preserved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Data-run identifier obtained from the job returned by GET_JOB. |

#### 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 |

### Launch Bot

**Slug:** `BOTSTER_LAUNCH_BOT`

Launch a Botster bot, creating external work that may spend account credits. Use CALCULATE_BOT_COST with the same input and options first when cost matters. Returns launch metadata and normalizes an identifiable job identifier to job_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | Main bot input. The selected bot may require a string or an array of strings. |
| `options` | object | No | Bot-specific option key/value pairs flattened into the launch body. Use the same options with CALCULATE_BOT_COST first because required fields vary by bot. |
| `webhook` | string | No | HTTPS callback URL that should receive a JSON POST when the job completes. |
| `bot_slug` | string | Yes | Bot identifier returned by LIST_BOTS. |

#### 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 Bots

**Slug:** `BOTSTER_LIST_BOTS`

List or search bots available to the connected account and return their identifiers for cost calculation and launch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per` | integer | No | Number of bots requested for this page. Botster documents 50 but does not publish an upper bound. |
| `search` | string | No | Text to match against available bots. |
| `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 Jobs

**Slug:** `BOTSTER_LIST_JOBS`

List jobs belonging to the connected Botster account and return job identifiers for inspection or lifecycle actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per` | integer | No | Number of jobs requested for this page; Botster documents 50 but does not publish a maximum. |
| `next_cursor` | string | No | Opaque continuation cursor from 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 |

### Restart Job

**Slug:** `BOTSTER_RESTART_JOB`

Restart an existing Botster job, creating renewed external work that may repeat the bot's effects and spend additional account credits. The renewed job identity may differ from the original; returns all provider restart metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Identifier of the job to restart. |

#### 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 |

### Set Job Archived

**Slug:** `BOTSTER_SET_JOB_ARCHIVED`

Archive a Botster job or restore it from the archive by setting its desired archived state. This reversible action changes organization state but does not delete the job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Identifier of the job whose archive state should change. |
| `archived` | boolean | Yes | Set true to archive the job or false to restore it from the archive. |

#### 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 |