V3 Bots

Create a bot run

Accepts a run input object conforming to the bot input_schema and returns a task_id for polling.

post/v3/bots/{bot_id}/runs

Request

  • Base URL: https://api.browseract.com
  • URL: https://api.browseract.com/v3/bots/{bot_id}/runs
  • Auth: HTTP bearer

Path parameters

bot_idstring required

Public bot identifier.

Request body

inputobject required

Run input object. Its shape must conform to the bot input_schema; use an empty object when no inputs are required.

callback_urlstring uri

HTTP or HTTPS endpoint notified when the run reaches a terminal status. Private and local addresses are not allowed.

status_change_callback_urlstring uri

HTTP or HTTPS endpoint notified after each public run status change. Private and local addresses are not allowed.

Response

Run created.

status'created' | 'running' | 'finished' | 'canceled' | 'pausing' | 'paused' | 'failed' required

Initial public run status.

task_idstring required

Public run task identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.