Start browser profiles in a batch

Client version1.8.0 (latest)1.7.0Version overview

POST

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/browsers/start/batch

Deduplicate profiles while preserving the order of first occurrence, then start them with bounded concurrency. Each item can set headless independently; if omitted, its profile command_line setting is used. Each profile returns its own success or error result. Business errors do not roll back profiles that have already started successfully.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Body parameters

requiredRequest content typeapplication/jsonBrowserBatchStartRequest

Fields

›object[]required

Profiles to start. For duplicate env_id values, only the first configuration is retained. Maximum: 10 profiles per batch.

minItems: 1maxItems: 10

›integer

Maximum concurrent starts; default: 5, maximum: 10

Default5

minimum: 1maximum: 10

Example

Generated from the schema; not a live response.

{
  "items": [
    {
      "env_id": "env_01JABCDEF1234567890"
    }
  ]
}

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "items": [
    {
      "env_id": "env_01JABCDEF1234567890"
    }
  ]
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch'

fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch", {
  method: "POST",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"items\": [\n    {\n      \"env_id\": \"env_01JABCDEF1234567890\"\n    }\n  ]\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "POST",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"items\": [\n    {\n      \"env_id\": \"env_01JABCDEF1234567890\"\n    }\n  ]\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "items": [
    {
      "env_id": "env_01JABCDEF1234567890"
    }
  ]
}',
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
	"strings"
)

func main() {
	req, err := http.NewRequest("POST", "http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch", strings.NewReader(`{
  "items": [
    {
      "env_id": "env_01JABCDEF1234567890"
    }
  ]
}`))
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    String body = "{\n" +
        "  \"items\": [\n" +
        "    {\n" +
        "      \"env_id\": \"env_01JABCDEF1234567890\"\n" +
        "    }\n" +
        "  ]\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("POST", HttpRequest.BodyPublishers.ofString(body))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/browsers/start/batch"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"items\": [\n    {\n      \"env_id\": \"env_01JABCDEF1234567890\"\n    }\n  ]\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

A completed batch can return HTTP 200 and code = 0 even when individual items fail. Check data.items[].success and data.items[].error for each result.

Individual batch start results

Body

Response content typeapplication/jsonBrowserBatchStartSuccessResponse

Fields

›numberrequired

Business status code; always 0 on success

Enum

›stringrequired

Business status message; always success on success

Enum

›objectrequired

Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 0,
    "success_count": 0,
    "failed_count": 0,
    "items": [
      {
        "env_id": "env_01JABCDEF1234567890",
        "success": true,
        "data": {
          "group": {
            "id": "string",
            "name": "string"
          },
          "status": "active",
          "headless": true,
          "ws_endpoint": "string",
          "reused": true
        }
      }
    ]
  }
}

View all business error codes and HTTP statuses