Browse AI
  1. robots
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. robots

Retrieve list of robots under your account

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/robots
robots
If you have already created a few robots on your dashboard, you can use this endpoint to retrieve a list of them.
You can then use other endpoints to retrieve more information about your robots or run robots.
请求示例请求示例
Go
Java
Objective-C
Shell
curl --location --request GET 'http://dev-cn.your-api-server.com/robots' \
--header 'authorization: Bearer YOUR_SECRET_API_KEY'
响应示例响应示例
200 - 示例 1
{
    "statusCode": 200,
    "messageCode": "success",
    "robots": {
        "totalCount": 20,
        "items": [
            {
                "id": "4f5cd7ff-6c98-4cac-8cf0-d7d0cb050b06",
                "name": "Extract data from Realtor.com",
                "createdAt": 1678795867879,
                "inputParameters": [
                    {
                        "type": "string",
                        "name": "originUrl",
                        "label": "Origin URL",
                        "encrypted": false,
                        "defaultValue": "https://www.espressozone.com/espresso-machines/semi-automatic-espresso-machines"
                    }
                ]
            }
        ]
    }
}

请求参数

Header 参数
authorization
string 
必需
You can generate a new API key on your dashboard if you do not have one.
示例值:
Bearer YOUR_SECRET_API_KEY

返回响应

🟢200A JSON containing the total number of robots and an array of robots under this team.
application/json
Body
statusCode
enum<number> 
必需
枚举值:
200
messageCode
enum<string> 
必需
枚举值:
success
robots
object 
必需
totalCount
integer 
必需
Total number of robots this team has.
示例值:
20
items
array[object (Robot) {4}] 
必需
🟠401The request is not authorized
修改于 2024-02-20 02:11:12
上一页
Retrieve list of teams under user account
下一页
Retrieve single robot by ID
Built with