Bulk run tasks - Browse AI

Bulk run up to 1,000 tasks at a time using a robot.

curl --location --request POST 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e/bulk-runs' \ --header 'authorization: Bearer YOUR_SECRET_API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{ "title": "Bulk Run Title", "inputParameters": [ { "originUrl": "https://www.ycombinator.com/companies/airbnb", "companies_skip": 0, "companies_limit": 10 }, { "originUrl": "https://www.ycombinator.com/companies/coinbase", "companies_skip": 0, "companies_limit": 20 } ] }'

{ "statusCode": 200, "messageCode": "success", "result": { "bulkRun": { "id": "f6fb62b6-f06a-4bf7-a623-c6a35c2e70b0", "title": "Bulk Run Title", "tasksCount": 10, "robotId": "4f5cd7ff-6c98-4cac-8cf0-d7d0cb050b06", "createdAt": 1678795867879 } } }

请求参数

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

Body 参数application/json

title

string

可选

A string that describes the bulk run.

>= 1 字符<= 200 字符

示例值:

Bulk Run Title

inputParameters

array[object (InputParameters) {1}]

必需

An array of input parameters to override the task's default input parameters.

示例值:

[{"originUrl":"https://www.ycombinator.com/companies/airbnb","companies_skip":0,"companies_limit":10},{"originUrl":"https://www.ycombinator.com/companies/coinbase","companies_skip":0,"companies_limit":20}]

额外字段

可选

示例

返回响应

🟢200A JSON object containing the newly created Bulk run.

application/json

Body

statusCode

enum<number>

必需

枚举值:

200

messageCode

enum<string>

必需

枚举值:

success

result

object

必需

bulkRun

object (BulkRun)

可选

🟠400A JSON containing error attributes. This will happen if any of the parameters are not valid.

🟠401The request is not authorized

🟠403A JSON containing error attributes.

🟠404The resource is not found

🔴500There was an error on the server

🔴503There was an error on the server