Browse AI

Retrieve single robot by ID

开发环境

http://dev-cn.your-api-server.com

GET

/robots/{robotId}

robots

You can use this endpoint to retrieve a single robot by ID.

请求示例

Java

Objective-C

Shell

curl --location --request GET 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e' \
--header 'authorization: Bearer YOUR_SECRET_API_KEY'

响应示例

200 - 示例 1

{
    "statusCode": 200,
    "messageCode": "success",
    "robot": {
        "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"
            }
        ]
    }
}

请求参数

Path 参数

robotId

string

必需

Unique robot ID You can find a robot's ID by opening it on the dashboard and copying its ID in the browser address bar.

示例值:

c3689adb-50aa-44af-b265-a7e0d4e5846e

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

robot

object (Robot)

必需

string

必需

Unique robot ID

示例值:

4f5cd7ff-6c98-4cac-8cf0-d7d0cb050b06

name

string

可选

Robot name

示例值:

Extract data from Realtor.com

createdAt

integer

必需

Robot creation date and time in the form of a Unix timestamp

示例值:

1678795867879

inputParameters

array [oneOf]

可选

🟠400A JSON containing an error code and message.

🟠401The request is not authorized

🟠404The resource is not found

🔴500There was an error on the server

修改于 2024-02-20 02:11:12

Retrieve list of robots under your account

Update a robot's cookies