Browse AI
  1. system
Browse AI
  • system
    • Endpoint for checking the status of Browse AI infrastructure
      GET
  • internal
    • Retrieve list of teams under user account
      GET
  • robots
    • Retrieve list of robots under your account
      GET
    • Retrieve single robot by ID
      GET
    • Update a robot's cookies
      PATCH
  • tasks
    • Get all tasks by a robot
      GET
    • Run a robot
      POST
    • Retrieve a task
      GET
  • monitors
    • Retrieve a robot's monitors
      GET
    • Create a new monitor on a robot
      POST
    • Retrieve a robot's monitor
      GET
    • Update a robot's monitor
      PATCH
    • Delete a robot's monitor
      DELETE
  • bulk runs
    • Bulk run tasks
      POST
    • Retrieve a robot's bulk runs list
      GET
    • Retrieve a robot's bulk run
      GET
  • webhooks
    • Retrieve a robot's webhooks
      GET
    • Create a new webhook on a robot
      POST
    • Delete a robot's webhook
      DELETE
  1. system

Endpoint for checking the status of Browse AI infrastructure

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/status
system
This endpoint provides you with real-time information regarding the operational status of the Browse AI infrastructure. It gives insights into the condition of the tasks queue, thus allowing you to understand if the services are running smoothly or are under maintenance.
请求示例请求示例
Go
Java
Objective-C
Shell
curl --location --request GET 'http://dev-cn.your-api-server.com/status' \
--header 'Authorization: Bearer YOUR_SECRET_API_KEY'
响应示例响应示例
{
    "statusCode": 200,
    "messageCode": "success",
    "tasksQueueStatus": "OK"
}

请求参数

Header 参数
Authorization
string 
必需
示例值:
Bearer YOUR_SECRET_API_KEY

返回响应

🟢200A JSON containing Browse AI infrastructure status
application/json
Body
statusCode
enum<number> 
可选
枚举值:
200
messageCode
enum<string> 
可选
枚举值:
success
tasksQueueStatus
enum<string> 
必需
枚举值:
OKUNDER_MAINTENANCE
示例值:
OK
修改于 2024-02-20 02:16:54
下一页
Retrieve list of teams under user account
Built with