Hivebrowser
API Reference

Profiles

Manage persistent browser state — cookies, local storage, and login sessions.

Use whenState must persist

Attach profiles when login state or customer context must survive.

ScopeSplit by account or workflow

Avoid one shared profile for unrelated jobs; isolation keeps recovery and access clear.

SafetyTreat unlock as recovery

Normal sessions sync; manual blob and lock paths are advanced.

API boundary: split profiles by account, customer, or workflow; let normal sessions handle automatic download and write-back; reserve manual blob, write-lock, and unlock operations for migration, backup, or abnormal recovery paths.

List Profiles

GET/v1/profilesShow endpoint detailsHide endpoint details
GET/v1/profiles

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

cURL
curl -X GET "https://api.hivebrowser.ai/v1/profiles" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles", {  headers: {    "Authorization": "Bearer <token>"  }});
Response 200

Profile list

Response example
{
  "data": {
    "items": [
      {
        "id": "string",
        "teamId": "string",
        "name": "string",
        "description": "string",
        "mode": "READ_ONLY",
        "status": "READY",
        "fingerprintConfig": {
          "property1": null,
          "property2": null
        },
        "proxyConfig": {
          "server": "string",
          "username": "string",
          "password": "string",
          "bypass": [
            "string"
          ]
        },
        "generatorProfileConfig": {
          "os": "string",
          "user_agent": "string",
          "webgl_vendor": "string",
          "webgl_renderer": "string",
          "languages": "string",
          "language_mode": "string",
          "timezone_mode": "string",
          "timezone": "string",
          "geolocation_mode": "string",
          "geolocation_latitude": 0,
          "geolocation_longitude": 0,
          "geolocation_accuracy": 0,
          "webrtc_mode": "string",
          "google_services_enabled": true,
          "fonts_masking": true,
          "media_devices_masking": true,
          "video_inputs": 0,
          "audio_inputs": 0,
          "audio_outputs": 0,
          "canvas_mode": "string",
          "client_rects_mode": "string",
          "audio_context_mode": "string",
          "webgl_image_mode": "string",
          "webgl_meta_mode": "string",
          "cpu_threads": 1,
          "ram": 1,
          "screen_resolution": "string",
          "proxy_type": "string",
          "proxy_host": "string",
          "proxy_port": "string",
          "proxy_user": "string",
          "proxy_pass": "string"
        },
        "latestStorageKey": "string",
        "latestVersion": 0,
        "latestBlobSizeBytes": "string",
        "lockedBySessionId": "string",
        "lockMode": "string",
        "lockAcquiredAt": "string",
        "lastUsedAt": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 0
  }
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}

Create a Profile

POST/v1/profilesShow endpoint detailsHide endpoint details
POST/v1/profiles

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
nameRequiredstring

Profile display name

Minimum length: 1Maximum length: 120
descriptionstring

Optional profile description

Maximum length: 500
modestring

Default access mode

Default: "READ_ONLY"Value in: "READ_ONLY" | "READ_WRITE"
fingerprintConfigobject

Raw fingerprint configuration

Show Attributes
[key: string]unknown
proxyConfigobject

Proxy configuration for this profile

Show Attributes
serverRequiredstring

Proxy server URL (e.g., http://proxy.example.com:8080)

Minimum length: 1
usernamestring

Proxy authentication username

Minimum length: 1
passwordstring

Proxy authentication password

Minimum length: 1
bypassarray<string>

List of hosts to bypass the proxy

generatorProfileConfigobject

Fingerprint generator configuration

Show Attributes
osstring

Operating system for fingerprint

user_agentstring

Custom user agent string

webgl_vendorstring

WebGL vendor string

webgl_rendererstring

WebGL renderer string

languagesstring | array<string>

Browser language(s)

Show Attributes
elementarray<string>
language_modestring
timezone_modestring
timezonestring

IANA timezone identifier

geolocation_modestring
geolocation_latitudenumber
geolocation_longitudenumber
geolocation_accuracyinteger
Minimum: 0
webrtc_modestring
google_services_enabledboolean
fonts_maskingboolean
media_devices_maskingboolean
video_inputsinteger
Minimum: 0
audio_inputsinteger
Minimum: 0
audio_outputsinteger
Minimum: 0
canvas_modestring
client_rects_modestring
audio_context_modestring
webgl_image_modestring
webgl_meta_modestring
cpu_threadsinteger
Minimum: 1
raminteger
Minimum: 1
screen_resolutionstring
proxy_typestring
proxy_hoststring
proxy_portstring | integer
proxy_userstring
proxy_passstring
[key: string]any
seedStateobject

Initial profile state (cookies, localStorage, etc.)

Show Attributes
[key: string]unknown
cURL
curl -X POST "https://api.hivebrowser.ai/v1/profiles" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string",    "mode": "READ_ONLY",    "fingerprintConfig": {      "property1": null,      "property2": null    },    "proxyConfig": {      "server": "string",      "username": "string",      "password": "string",      "bypass": [        "string"      ]    },    "generatorProfileConfig": {      "os": "string",      "user_agent": "string",      "webgl_vendor": "string",      "webgl_renderer": "string",      "languages": "string",      "language_mode": "string",      "timezone_mode": "string",      "timezone": "string",      "geolocation_mode": "string",      "geolocation_latitude": 0,      "geolocation_longitude": 0,      "geolocation_accuracy": 0,      "webrtc_mode": "string",      "google_services_enabled": true,      "fonts_masking": true,      "media_devices_masking": true,      "video_inputs": 0,      "audio_inputs": 0,      "audio_outputs": 0,      "canvas_mode": "string",      "client_rects_mode": "string",      "audio_context_mode": "string",      "webgl_image_mode": "string",      "webgl_meta_mode": "string",      "cpu_threads": 1,      "ram": 1,      "screen_resolution": "string",      "proxy_type": "string",      "proxy_host": "string",      "proxy_port": "string",      "proxy_user": "string",      "proxy_pass": "string"    },    "seedState": {      "property1": null,      "property2": null    }  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "name": "string",    "description": "string",    "mode": "READ_ONLY",    "fingerprintConfig": {      "property1": null,      "property2": null    },    "proxyConfig": {      "server": "string",      "username": "string",      "password": "string",      "bypass": [        "string"      ]    },    "generatorProfileConfig": {      "os": "string",      "user_agent": "string",      "webgl_vendor": "string",      "webgl_renderer": "string",      "languages": "string",      "language_mode": "string",      "timezone_mode": "string",      "timezone": "string",      "geolocation_mode": "string",      "geolocation_latitude": 0,      "geolocation_longitude": 0,      "geolocation_accuracy": 0,      "webrtc_mode": "string",      "google_services_enabled": true,      "fonts_masking": true,      "media_devices_masking": true,      "video_inputs": 0,      "audio_inputs": 0,      "audio_outputs": 0,      "canvas_mode": "string",      "client_rects_mode": "string",      "audio_context_mode": "string",      "webgl_image_mode": "string",      "webgl_meta_mode": "string",      "cpu_threads": 1,      "ram": 1,      "screen_resolution": "string",      "proxy_type": "string",      "proxy_host": "string",      "proxy_port": "string",      "proxy_user": "string",      "proxy_pass": "string"    },    "seedState": {      "property1": null,      "property2": null    }  })});
Response 201

Profile created

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "description": "string",
    "mode": "READ_ONLY",
    "status": "READY",
    "fingerprintConfig": {
      "property1": null,
      "property2": null
    },
    "proxyConfig": {
      "server": "string",
      "username": "string",
      "password": "string",
      "bypass": [
        "string"
      ]
    },
    "generatorProfileConfig": {
      "os": "string",
      "user_agent": "string",
      "webgl_vendor": "string",
      "webgl_renderer": "string",
      "languages": "string",
      "language_mode": "string",
      "timezone_mode": "string",
      "timezone": "string",
      "geolocation_mode": "string",
      "geolocation_latitude": 0,
      "geolocation_longitude": 0,
      "geolocation_accuracy": 0,
      "webrtc_mode": "string",
      "google_services_enabled": true,
      "fonts_masking": true,
      "media_devices_masking": true,
      "video_inputs": 0,
      "audio_inputs": 0,
      "audio_outputs": 0,
      "canvas_mode": "string",
      "client_rects_mode": "string",
      "audio_context_mode": "string",
      "webgl_image_mode": "string",
      "webgl_meta_mode": "string",
      "cpu_threads": 1,
      "ram": 1,
      "screen_resolution": "string",
      "proxy_type": "string",
      "proxy_host": "string",
      "proxy_port": "string",
      "proxy_user": "string",
      "proxy_pass": "string"
    },
    "latestStorageKey": "string",
    "latestVersion": 0,
    "latestBlobSizeBytes": "string",
    "lockedBySessionId": "string",
    "lockMode": "string",
    "lockAcquiredAt": "string",
    "lastUsedAt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "latestBlobState": {},
    "recentVersions": [
      {
        "id": "string",
        "teamId": "string",
        "profileId": "string",
        "version": 1,
        "objectKey": "string",
        "sizeBytes": "string",
        "checksum": "string",
        "createdBySessionId": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 429

Profile quota exceeded

Response example
{
  "error": "string",
  "message": "string"
}

Get a Profile

GET/v1/profiles/{id}Show endpoint detailsHide endpoint details
GET/v1/profiles/{id}

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Path Parameters

idRequiredstring

Profile ID

cURL
curl -X GET "https://api.hivebrowser.ai/v1/profiles/string" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles/string", {  headers: {    "Authorization": "Bearer <token>"  }});
Response 200

Profile details

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "description": "string",
    "mode": "READ_ONLY",
    "status": "READY",
    "fingerprintConfig": {
      "property1": null,
      "property2": null
    },
    "proxyConfig": {
      "server": "string",
      "username": "string",
      "password": "string",
      "bypass": [
        "string"
      ]
    },
    "generatorProfileConfig": {
      "os": "string",
      "user_agent": "string",
      "webgl_vendor": "string",
      "webgl_renderer": "string",
      "languages": "string",
      "language_mode": "string",
      "timezone_mode": "string",
      "timezone": "string",
      "geolocation_mode": "string",
      "geolocation_latitude": 0,
      "geolocation_longitude": 0,
      "geolocation_accuracy": 0,
      "webrtc_mode": "string",
      "google_services_enabled": true,
      "fonts_masking": true,
      "media_devices_masking": true,
      "video_inputs": 0,
      "audio_inputs": 0,
      "audio_outputs": 0,
      "canvas_mode": "string",
      "client_rects_mode": "string",
      "audio_context_mode": "string",
      "webgl_image_mode": "string",
      "webgl_meta_mode": "string",
      "cpu_threads": 1,
      "ram": 1,
      "screen_resolution": "string",
      "proxy_type": "string",
      "proxy_host": "string",
      "proxy_port": "string",
      "proxy_user": "string",
      "proxy_pass": "string"
    },
    "latestStorageKey": "string",
    "latestVersion": 0,
    "latestBlobSizeBytes": "string",
    "lockedBySessionId": "string",
    "lockMode": "string",
    "lockAcquiredAt": "string",
    "lastUsedAt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "latestBlobState": {},
    "recentVersions": [
      {
        "id": "string",
        "teamId": "string",
        "profileId": "string",
        "version": 1,
        "objectKey": "string",
        "sizeBytes": "string",
        "checksum": "string",
        "createdBySessionId": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  }
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

Delete a Profile

DELETE/v1/profiles/{id}Show endpoint detailsHide endpoint details
DELETE/v1/profiles/{id}

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Path Parameters

idRequiredstring

Profile ID

cURL
curl -X DELETE "https://api.hivebrowser.ai/v1/profiles/string" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles/string", {  headers: {    "Authorization": "Bearer <token>"  }});
Response 204

Profile deleted

Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}
Response 409

Profile is locked or in use

Response example
{
  "error": "string",
  "message": "string"
}

Persist Profile Blob

POST/v1/profiles/{id}/blobShow endpoint detailsHide endpoint details
POST/v1/profiles/{id}/blob

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
stateRequiredobject

Profile state data to persist

Show Attributes
[key: string]unknown
sourceSessionIdstring

Session that produced this state

Minimum length: 1

Path Parameters

idRequiredstring

Profile ID

cURL
curl -X POST "https://api.hivebrowser.ai/v1/profiles/string/blob" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "state": {      "property1": null,      "property2": null    },    "sourceSessionId": "string"  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles/string/blob", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "state": {      "property1": null,      "property2": null    },    "sourceSessionId": "string"  })});
Response 200

Profile blob persisted

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "description": "string",
    "mode": "READ_ONLY",
    "status": "READY",
    "fingerprintConfig": {
      "property1": null,
      "property2": null
    },
    "proxyConfig": {
      "server": "string",
      "username": "string",
      "password": "string",
      "bypass": [
        "string"
      ]
    },
    "generatorProfileConfig": {
      "os": "string",
      "user_agent": "string",
      "webgl_vendor": "string",
      "webgl_renderer": "string",
      "languages": "string",
      "language_mode": "string",
      "timezone_mode": "string",
      "timezone": "string",
      "geolocation_mode": "string",
      "geolocation_latitude": 0,
      "geolocation_longitude": 0,
      "geolocation_accuracy": 0,
      "webrtc_mode": "string",
      "google_services_enabled": true,
      "fonts_masking": true,
      "media_devices_masking": true,
      "video_inputs": 0,
      "audio_inputs": 0,
      "audio_outputs": 0,
      "canvas_mode": "string",
      "client_rects_mode": "string",
      "audio_context_mode": "string",
      "webgl_image_mode": "string",
      "webgl_meta_mode": "string",
      "cpu_threads": 1,
      "ram": 1,
      "screen_resolution": "string",
      "proxy_type": "string",
      "proxy_host": "string",
      "proxy_port": "string",
      "proxy_user": "string",
      "proxy_pass": "string"
    },
    "latestStorageKey": "string",
    "latestVersion": 0,
    "latestBlobSizeBytes": "string",
    "lockedBySessionId": "string",
    "lockMode": "string",
    "lockAcquiredAt": "string",
    "lastUsedAt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}
Response 409

Blob persist conflict

Response example
{
  "error": "string",
  "message": "string"
}

Update Generator Config

POST/v1/profiles/{id}/generator-configShow endpoint detailsHide endpoint details
POST/v1/profiles/{id}/generator-config

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
generatorProfileConfigRequiredobject

New generator config, or null to clear

Show Attributes
osstring

Operating system for fingerprint

user_agentstring

Custom user agent string

webgl_vendorstring

WebGL vendor string

webgl_rendererstring

WebGL renderer string

languagesstring | array<string>

Browser language(s)

Show Attributes
elementarray<string>
language_modestring
timezone_modestring
timezonestring

IANA timezone identifier

geolocation_modestring
geolocation_latitudenumber
geolocation_longitudenumber
geolocation_accuracyinteger
Minimum: 0
webrtc_modestring
google_services_enabledboolean
fonts_maskingboolean
media_devices_maskingboolean
video_inputsinteger
Minimum: 0
audio_inputsinteger
Minimum: 0
audio_outputsinteger
Minimum: 0
canvas_modestring
client_rects_modestring
audio_context_modestring
webgl_image_modestring
webgl_meta_modestring
cpu_threadsinteger
Minimum: 1
raminteger
Minimum: 1
screen_resolutionstring
proxy_typestring
proxy_hoststring
proxy_portstring | integer
proxy_userstring
proxy_passstring
[key: string]any

Path Parameters

idRequiredstring

Profile ID

cURL
curl -X POST "https://api.hivebrowser.ai/v1/profiles/string/generator-config" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "generatorProfileConfig": {      "os": "string",      "user_agent": "string",      "webgl_vendor": "string",      "webgl_renderer": "string",      "languages": "string",      "language_mode": "string",      "timezone_mode": "string",      "timezone": "string",      "geolocation_mode": "string",      "geolocation_latitude": 0,      "geolocation_longitude": 0,      "geolocation_accuracy": 0,      "webrtc_mode": "string",      "google_services_enabled": true,      "fonts_masking": true,      "media_devices_masking": true,      "video_inputs": 0,      "audio_inputs": 0,      "audio_outputs": 0,      "canvas_mode": "string",      "client_rects_mode": "string",      "audio_context_mode": "string",      "webgl_image_mode": "string",      "webgl_meta_mode": "string",      "cpu_threads": 1,      "ram": 1,      "screen_resolution": "string",      "proxy_type": "string",      "proxy_host": "string",      "proxy_port": "string",      "proxy_user": "string",      "proxy_pass": "string"    }  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles/string/generator-config", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "generatorProfileConfig": {      "os": "string",      "user_agent": "string",      "webgl_vendor": "string",      "webgl_renderer": "string",      "languages": "string",      "language_mode": "string",      "timezone_mode": "string",      "timezone": "string",      "geolocation_mode": "string",      "geolocation_latitude": 0,      "geolocation_longitude": 0,      "geolocation_accuracy": 0,      "webrtc_mode": "string",      "google_services_enabled": true,      "fonts_masking": true,      "media_devices_masking": true,      "video_inputs": 0,      "audio_inputs": 0,      "audio_outputs": 0,      "canvas_mode": "string",      "client_rects_mode": "string",      "audio_context_mode": "string",      "webgl_image_mode": "string",      "webgl_meta_mode": "string",      "cpu_threads": 1,      "ram": 1,      "screen_resolution": "string",      "proxy_type": "string",      "proxy_host": "string",      "proxy_port": "string",      "proxy_user": "string",      "proxy_pass": "string"    }  })});
Response 200

Generator config updated

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "description": "string",
    "mode": "READ_ONLY",
    "status": "READY",
    "fingerprintConfig": {
      "property1": null,
      "property2": null
    },
    "proxyConfig": {
      "server": "string",
      "username": "string",
      "password": "string",
      "bypass": [
        "string"
      ]
    },
    "generatorProfileConfig": {
      "os": "string",
      "user_agent": "string",
      "webgl_vendor": "string",
      "webgl_renderer": "string",
      "languages": "string",
      "language_mode": "string",
      "timezone_mode": "string",
      "timezone": "string",
      "geolocation_mode": "string",
      "geolocation_latitude": 0,
      "geolocation_longitude": 0,
      "geolocation_accuracy": 0,
      "webrtc_mode": "string",
      "google_services_enabled": true,
      "fonts_masking": true,
      "media_devices_masking": true,
      "video_inputs": 0,
      "audio_inputs": 0,
      "audio_outputs": 0,
      "canvas_mode": "string",
      "client_rects_mode": "string",
      "audio_context_mode": "string",
      "webgl_image_mode": "string",
      "webgl_meta_mode": "string",
      "cpu_threads": 1,
      "ram": 1,
      "screen_resolution": "string",
      "proxy_type": "string",
      "proxy_host": "string",
      "proxy_port": "string",
      "proxy_user": "string",
      "proxy_pass": "string"
    },
    "latestStorageKey": "string",
    "latestVersion": 0,
    "latestBlobSizeBytes": "string",
    "lockedBySessionId": "string",
    "lockMode": "string",
    "lockAcquiredAt": "string",
    "lastUsedAt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

Acquire Write Lock

POST/v1/profiles/{id}/locks/writeShow endpoint detailsHide endpoint details
POST/v1/profiles/{id}/locks/write

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
sessionIdRequiredstring

Session ID requesting the lock

Minimum length: 1

Path Parameters

idRequiredstring

Profile ID

cURL
curl -X POST "https://api.hivebrowser.ai/v1/profiles/string/locks/write" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string"  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles/string/locks/write", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string"  })});
Response 200

Write lock acquired

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "description": "string",
    "mode": "READ_ONLY",
    "status": "READY",
    "fingerprintConfig": {
      "property1": null,
      "property2": null
    },
    "proxyConfig": {
      "server": "string",
      "username": "string",
      "password": "string",
      "bypass": [
        "string"
      ]
    },
    "generatorProfileConfig": {
      "os": "string",
      "user_agent": "string",
      "webgl_vendor": "string",
      "webgl_renderer": "string",
      "languages": "string",
      "language_mode": "string",
      "timezone_mode": "string",
      "timezone": "string",
      "geolocation_mode": "string",
      "geolocation_latitude": 0,
      "geolocation_longitude": 0,
      "geolocation_accuracy": 0,
      "webrtc_mode": "string",
      "google_services_enabled": true,
      "fonts_masking": true,
      "media_devices_masking": true,
      "video_inputs": 0,
      "audio_inputs": 0,
      "audio_outputs": 0,
      "canvas_mode": "string",
      "client_rects_mode": "string",
      "audio_context_mode": "string",
      "webgl_image_mode": "string",
      "webgl_meta_mode": "string",
      "cpu_threads": 1,
      "ram": 1,
      "screen_resolution": "string",
      "proxy_type": "string",
      "proxy_host": "string",
      "proxy_port": "string",
      "proxy_user": "string",
      "proxy_pass": "string"
    },
    "latestStorageKey": "string",
    "latestVersion": 0,
    "latestBlobSizeBytes": "string",
    "lockedBySessionId": "string",
    "lockMode": "string",
    "lockAcquiredAt": "string",
    "lastUsedAt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}
Response 409

Profile is already locked

Response example
{
  "error": "string",
  "message": "string"
}

Release Write Lock

POST/v1/profiles/{id}/unlockShow endpoint detailsHide endpoint details
POST/v1/profiles/{id}/unlock

Authorization

AuthorizationRequiredBearer <token>

API key passed as a Bearer token in the Authorization header.

In: header

x-hivebrowser-api-key<token>

API key passed directly in the x-hivebrowser-api-key header.

In: header

Request Body

application/jsonRequired
sessionIdRequiredstring

Session ID requesting the lock

Minimum length: 1

Path Parameters

idRequiredstring

Profile ID

cURL
curl -X POST "https://api.hivebrowser.ai/v1/profiles/string/unlock" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string"  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/profiles/string/unlock", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string"  })});
Response 200

Write lock released

Response example
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "description": "string",
    "mode": "READ_ONLY",
    "status": "READY",
    "fingerprintConfig": {
      "property1": null,
      "property2": null
    },
    "proxyConfig": {
      "server": "string",
      "username": "string",
      "password": "string",
      "bypass": [
        "string"
      ]
    },
    "generatorProfileConfig": {
      "os": "string",
      "user_agent": "string",
      "webgl_vendor": "string",
      "webgl_renderer": "string",
      "languages": "string",
      "language_mode": "string",
      "timezone_mode": "string",
      "timezone": "string",
      "geolocation_mode": "string",
      "geolocation_latitude": 0,
      "geolocation_longitude": 0,
      "geolocation_accuracy": 0,
      "webrtc_mode": "string",
      "google_services_enabled": true,
      "fonts_masking": true,
      "media_devices_masking": true,
      "video_inputs": 0,
      "audio_inputs": 0,
      "audio_outputs": 0,
      "canvas_mode": "string",
      "client_rects_mode": "string",
      "audio_context_mode": "string",
      "webgl_image_mode": "string",
      "webgl_meta_mode": "string",
      "cpu_threads": 1,
      "ram": 1,
      "screen_resolution": "string",
      "proxy_type": "string",
      "proxy_host": "string",
      "proxy_port": "string",
      "proxy_user": "string",
      "proxy_pass": "string"
    },
    "latestStorageKey": "string",
    "latestVersion": 0,
    "latestBlobSizeBytes": "string",
    "lockedBySessionId": "string",
    "lockMode": "string",
    "lockAcquiredAt": "string",
    "lastUsedAt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Response 400

Invalid request payload

Response example
{
  "error": "string",
  "message": "string"
}
Response 401

Missing or invalid API key

Response example
{
  "error": "string",
  "message": "string"
}
Response 404

Resource not found

Response example
{
  "error": "string",
  "message": "string"
}

On this page

List ProfilesCreate a ProfileGet a ProfileDelete a ProfilePersist Profile BlobUpdate Generator ConfigAcquire Write LockRelease Write Lock