Create a browser profile

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

Create a single browser profile for the current user and team without starting it. The request contains only public configuration settings. The Local API supplies the actual desktop platform and resolves API proxies locally. The backend generates internal fingerprint values such as UA Client Hints, noise, battery information, and media devices.

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/jsonBrowserCreateRequest

Fields

›stringrequired

Browser profile name

minLength: 1maxLength: 32

›object

Browser window size; defaults to 800 x 600 if omitted

Default{"width":800,"height":600}

Additional fields are not allowed.

›objectrequired

Compatibility settings for the browser engine, fingerprint operating system, and User-Agent

Additional fields are not allowed.

›string | null

Profile group ID; uses the default group if omitted or null

minLength: 1maxLength: 32

›object[] | null

List of Puppeteer Cookie objects; each item must include at least name and value

maxItems: 500

›string | null

Browser profile notes

maxLength: 5000

›string | null

Browser startup arguments, in the same format as the profile configuration in the graphical interface

maxLength: 5000

›object

Profile proxy settings; no proxy is used if omitted

Default{"mode":"none"}

›string[]

List of existing account IDs from account management to bind

Default[]

maxItems: 100

Each array item:

Unique account ID

Example"account_01JABCDEF1234567890"

minLength: 1

›object[]

Accounts to create and bind when creating the profile. Using this field also requires account creation permission.

Default[]

maxItems: 20

›string[]

List of personal or team extension IDs to bind

Default[]

maxItems: 100

Each array item:

Unique extension ID

Example"extension_01JABCDEF1234567890"

minLength: 1

›object

Common browser settings; if the object or any child field is omitted, the corresponding field defaults are used

Default{"image_size_limit_kb":null,"restore_last_session":true,"block_video_autoplay":false,"disable_video_preload":false,"mute_audio":false,"disable_translate_prompt":false,"disable_password_save_prompt":false,"block_notifications":false,"block_clipboard_read":false,"stop_open_on_network_error":false,"stop_open_on_ip_change":false,"stop_open_on_country_change":false,"search_engine_preset":null}

Additional fields are not allowed.

›object

Browser fingerprint settings; each field uses its default mode if omitted

Default{"webrtc":{"mode":"based_on_ip"},"timezone":{"mode":"based_on_ip"},"geolocation":{"mode":"based_on_ip"},"language":{"mode":"based_on_ip"},"screen":{"mode":"random"},"fonts":{"mode":"random"},"noise":{"canvas":true,"webgl":true,"audio_context":true,"client_rects":true},"memory":{"mode":"random"},"cpu":{"mode":"random"},"do_not_track":{"mode":"default"},"port_scan_protection":{"mode":"enabled"},"hardware_acceleration":{"mode":"default"},"battery":{"mode":"random"},"media_devices":{"mode":"random"}}

Additional fields are not allowed.

›boolean

Whether to randomize the fingerprint again whenever the profile is opened

Defaultfalse

Example

Generated from the schema; not a live response.

{
  "name": "string",
  "browser": {
    "kernel_version": "string"
  }
}

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 '{
  "name": "string",
  "browser": {
    "kernel_version": "string"
  }
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers'

fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers", {
  method: "POST",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"string\",\n  \"browser\": {\n    \"kernel_version\": \"string\"\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  \"name\": \"string\",\n  \"browser\": {\n    \"kernel_version\": \"string\"\n  }\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers", 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');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "string",
  "browser": {
    "kernel_version": "string"
  }
}',
]);

$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", strings.NewReader(`{
  "name": "string",
  "browser": {
    "kernel_version": "string"
  }
}`))
	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" +
        "  \"name\": \"string\",\n" +
        "  \"browser\": {\n" +
        "    \"kernel_version\": \"string\"\n" +
        "  }\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/browsers"))
        .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"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"string\",\n  \"browser\": {\n    \"kernel_version\": \"string\"\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.

ID of the created browser profile

Body

Response content typeapplication/jsonBrowserCreateSuccessResponse

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": {
    "env_id": "env_01JABCDEF1234567890",
    "name": "string",
    "status": "inactive"
  }
}

View all business error codes and HTTP statuses