> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Botster

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

![Botster logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/botster.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=f7e286b96e92b08e543c1d33921e725b)

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

## Tools

> [accordion] 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
>
> **input** `string` *required*
>
> Main bot input exactly as intended for launch; Botster accepts a string or an array of strings depending on the bot.
>
> **options** `object`
>
> 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` *required*
>
> Bot identifier returned by LIST\_BOTS, for example 'google-local-finder'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **job\_id** `string` *required*
>
> Identifier of the job to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **run\_id** `string` *required*
>
> Identifier of the data run to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **job\_id** `string` *required*
>
> Job identifier returned by LAUNCH\_BOT or LIST\_JOBS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **run\_id** `string` *required*
>
> Data-run identifier obtained from the job returned by GET\_JOB.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **input** `string` *required*
>
> Main bot input. The selected bot may require a string or an array of strings.
>
> **options** `object`
>
> 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`
>
> HTTPS callback URL that should receive a JSON POST when the job completes.
>
> **bot\_slug** `string` *required*
>
> Bot identifier returned by LIST\_BOTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **per** `integer`
>
> Number of bots requested for this page. Botster documents 50 but does not publish an upper bound.
>
> **search** `string`
>
> Text to match against available bots.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **per** `integer`
>
> Number of jobs requested for this page; Botster documents 50 but does not publish a maximum.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **job\_id** `string` *required*
>
> Identifier of the job to restart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **job\_id** `string` *required*
>
> Identifier of the job whose archive state should change.
>
> **archived** `boolean` *required*
>
> Set true to archive the job or false to restore it from the archive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
