> ## Documentation Index > Fetch the complete documentation index at: https://docs.browseract.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a task > Returns comprehensive information about a task, including its current `status`, accepted `input`, output, failure details, files, live browser information, and Bot step summaries when available. Fields that do not apply to the run type or state are omitted. Official template runs do not expose template source fields or the internally copied Bot ID. If you only need the current status, use `GET /v3/bots/runs/{task_id}/status`. ## OpenAPI ````yaml /openapi_3.json get /v3/bots/runs/{task_id} openapi: 3.0.3 info: title: BrowserAct API description: > BrowserAct's API lets you list and run BrowserAct bots programmatically and monitor their execution. **Core concepts (same as the Dashboard):** - **Bot**: a published Bot automation that can be run through the API. - **Task**: a single bot execution record (the "run"). The public `bot_type=agent` value represents **SkillFlow**, not the legacy Agent app type. ## Base URL All requests use the following base URL: ``` https://api.browseract.com ``` ## API versioning The API is versioned in the URL path (for example, `/v3/bots/...`). ## Authentication Authenticate with a Bearer token in the `Authorization` header: ``` Authorization: Bearer ``` API keys are scoped to a company and channel. Do not send internal session headers such as `x-session-company-id` or `x-session-api-channel`; BrowserAct injects them after authentication. ## Requests - Send request bodies as JSON. - Set `Content-Type: application/json` for endpoints that accept a body. - Run inputs use an `input` object that must conform to the bot or template `input_schema`. ## Response codes - `200` for successful queries, creates, cancels, and resumes - `400` for invalid parameters, business validation failures, or resources not visible to the current API key - `500` for server-side errors Successful responses return the business object directly without a data wrapper. Error responses use `code`, `msg`, `data`, `ts`, `time`, and `traceId`. ## Pagination List endpoints use **page-based pagination** with these query parameters: - `page` (starts at 1) - `limit` (maximum depends on the endpoint) Paginated responses include `page`, `limit`, `items`, `total_pages`, and `total_count`. ## Webhooks (optional) When creating a task, you can provide: - `callback_url`: called when a task **finishes**, **fails**, or is **canceled**. - `status_change_callback_url`: called whenever the public task status changes. Both callbacks receive the complete `BotRunDetailResponse` directly, without an additional `data` wrapper. Callback URLs cannot resolve to private or local addresses. ## Task status values `created`, `running`, `pausing`, `paused`, `finished`, `canceled`, `failed`. ## Common error codes - `99001`: Request parameter error - `99002`: No operation permission - `10013`: Proxy region does not exist - `10020`: Bot is not published - `10021`: SkillFlow LLM configuration is incomplete - `10111`: Bot does not exist or is not visible - `10112`: Task does not exist - `10121`: Task has already completed - `10127`: Only a paused task can be resumed - `10142`: Required Bot input is missing - `10143`: Required SkillFlow input is missing - `10176`: Bot template does not exist - `10879`: SkillFlow runs do not support resume ## Rate limits To protect platform stability, rate limits may apply. If you hit a limit, reduce request frequency and retry with backoff. ## Need help? Join our Discord community: https://discord.com/invite/UpnCKd7GaU version: v3 contact: name: BrowserAct Support url: https://discord.com/invite/UpnCKd7GaU servers: - url: https://api.browseract.com description: API host security: - HTTPBearer: [] tags: - name: Tasks description: >- Create and manage bot execution tasks. Start a task, poll its status or full details, and retrieve outputs after it finishes. - name: Bots description: >- Bots are published Bot automations. Use these endpoints to list runnable bots and inspect their input and output schemas. - name: Bot Templates description: >- Official Bot templates curated by BrowserAct. Templates provide a fast way to start common scraping and automation use cases. - name: Regions description: >- Supported proxy regions that can be used when running an official Bot template. paths: /v3/bots/runs/{task_id}: get: tags: - Tasks summary: Retrieve a task description: >- Returns comprehensive information about a task, including its current `status`, accepted `input`, output, failure details, files, live browser information, and Bot step summaries when available. Fields that do not apply to the run type or state are omitted. Official template runs do not expose template source fields or the internally copied Bot ID. If you only need the current status, use `GET /v3/bots/runs/{task_id}/status`. operationId: queryRun parameters: - name: task_id in: path required: true description: Task ID schema: type: string example: '93001' responses: '200': description: Run returned. content: application/json: schema: $ref: '#/components/schemas/BotRunDetailResponse' example: task_id: '93001' log_detail_url: https://www.browseract.com/reception/logs?keyword=93001 bot_id: '1001' bot_type: agent bot_name: Business Contact Finder Bot status: finished created_at: '2026-08-13T09:00:00Z' finished_at: '2026-08-13T09:02:00Z' input: company_name: Example Corp output: company_name: Example Corp official_website_url: https://example.com linkedin_url: https://www.linkedin.com/company/example-company x_url: https://x.com/example_company youtube_url: https://www.youtube.com/@example-company facebook_url: null instagram_url: https://www.instagram.com/example_company tiktok_url: https://www.tiktok.com/@example_company github_url: https://github.com/example-company other_social_profiles: - platform: discord url: https://discord.gg/example rss_feed_url: https://example.com/news/rss.xml source_search_url: https://www.google.com/search?q=Example+Corp evidence_urls: - https://www.google.com/search?q=Example+Corp - https://example.com - https://example.com/news - https://example.com/news/rss.xml - https://example.com/about output_files: md: file_name: result.md file_size: 1024 download_url: https://signed-url/result.md csv: file_name: result.csv file_size: 768 download_url: https://signed-url/result.csv xml: file_name: result.xml file_size: 1152 download_url: https://signed-url/result.xml json: file_name: result.json file_size: 896 download_url: https://signed-url/result.json download_files: - guid: file-example-001 file_name: company-profile.pdf file_size: 245760 status: completed progress: 100 download_url: https://signed-url/company-profile.pdf download_start_time: 1786611630000 download_completed_time: 1786611645000 expires_at: 1786688520000 create_time: 1786611620000 files_expires_at: 1786688520000 live_url_info: width: 1280 height: 1024 live_url: https://www.browseract.com/remote/example-session credit: 42 '400': description: Run not found. Returns error code 10112. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: BotRunDetailResponse: type: object properties: task_id: type: string description: Task ID log_detail_url: type: string format: uri description: URL to detailed execution logs for this task. bot_id: type: string description: Public bot identifier used by a normal Bot run. bot_type: $ref: '#/components/schemas/BotType' bot_name: type: string description: Bot display name when available for a normal Bot run. status: $ref: '#/components/schemas/BotRunStatus' created_at: type: string format: date-time description: Task creation time finished_at: type: string format: date-time description: Task finish time (if ended) input: type: object additionalProperties: true description: Input object accepted for this run. task_failure_info: $ref: '#/components/schemas/BotRunFailureInfoResponse' output: nullable: true description: Present only when the task has ended. output_files: type: object additionalProperties: $ref: '#/components/schemas/BotRunOutputFileResponse' description: >- Business result files keyed by format, for example json, md, csv or xml. download_files: type: array items: $ref: '#/components/schemas/BotRunDownloadFileResponse' description: Files generated by the task (if any). files_expires_at: type: integer format: int64 description: Expiration timestamp for download files. steps: type: array items: $ref: '#/components/schemas/TaskStepDto' description: Steps executed within the task. live_url_info: $ref: '#/components/schemas/BotRunLiveUrlInfoResponse' description: Present only when the task is `running`. credit: type: integer format: int64 description: Credits consumed by this task. required: - task_id - log_detail_url - bot_type - status - created_at - input ErrorResponse: type: object properties: code: type: integer description: Response code. `0` means success; non-zero means failure. msg: type: string description: Human-readable error message (present when `code` is non-zero). data: type: object nullable: true description: Error details (shape may vary by error). ts: type: integer format: int64 description: Server timestamp (milliseconds). time: type: string description: Server time. traceId: type: string description: Error ID for tracking in logs. required: - code - msg - ts - time - traceId example: code: 123 msg: Invalid task_id data: null ts: 1786634400000 time: '2026-08-13 18:00:00' traceId: a1b2c3d4e5f6 BotType: type: string enum: - workflow - agent description: >- Public bot type. agent represents SkillFlow, not the legacy Agent app type. BotRunStatus: type: string enum: - created - running - finished - canceled - pausing - paused - failed description: Public lifecycle status of a bot run. BotRunFailureInfoResponse: type: object properties: code: type: integer description: Error code message: type: string description: Error message required: - code - message BotRunOutputFileResponse: type: object properties: file_name: type: string description: Business result file name. file_size: type: integer format: int64 description: Business result file size in bytes when available. download_url: type: string description: Temporary URL for downloading the business result file. required: - file_name - download_url BotRunDownloadFileResponse: type: object properties: guid: type: string description: File unique identifier file_name: type: string description: Display file name. file_size: type: integer format: int64 description: File size in bytes. status: type: string description: File status (value may vary) progress: type: integer description: Download progress (0-100) download_url: type: string description: Temporary download URL, available after upload completes. download_start_time: type: integer format: int64 description: Download start time in epoch milliseconds. download_completed_time: type: integer format: int64 description: Download completion time in epoch milliseconds. expires_at: type: integer format: int64 description: Download expiration time in epoch milliseconds. error_message: type: string description: >- Failure or cancellation message when file transfer does not complete. create_time: type: integer format: int64 description: File record creation time in epoch milliseconds. TaskStepDto: type: object properties: id: type: string description: Step ID step: type: integer description: Step sequence number evaluation_previous_goal: type: string description: Evaluation result of the previous step step_goal: type: string description: Goal of the current step screenshots_url: type: string description: Screenshot URL captured during this step status: $ref: '#/components/schemas/TaskStepStatusEnum' required: - id - step - evaluation_previous_goal - step_goal - screenshots_url - status BotRunLiveUrlInfoResponse: type: object properties: live_url: type: string description: Live view URL. Can be embedded in an `