Create Session

Start a browser session and give the agent its task. The run begins immediately, and the response carries the session id you poll for progress.

Create Session. Send this to your own instance, replacing your-host with the hostname it answers on.

curl -X POST "https://your-host/v3/sessions" \
  -H "Authorization: Bearer $OPENBROWSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

task?string|null

model?Model

Optional. Omit it and the session runs on whatever the instance's DEFAULT_MODEL names, which is gpt-5.6-terra unless its operator changed it.

sessionId?string|null

keepAlive?Keepalive

Defaultfalse

maxCostUsd?|null

profileId?string|null

outputSchema?|null

sensitiveData?|null

systemPromptExtension?string|null

skills?Skills

Accepted for compatibility with browser-use-sdk and ignored.

Defaulttrue

enableRecording?Enablerecording

Accepted for compatibility with browser-use-sdk and ignored. OpenBrowse does not record sessions, and recordingUrls comes back empty. Use the live view instead.

Defaultfalse

proxyCountryCode?|

Accepted for compatibility with browser-use-sdk and ignored. OpenBrowse has no proxy layer, so requests originate from your own machine's IP address whatever you set here.

reasoningEffort?|

Optional. One of default, none, low, medium, high, xhigh or max, validated against the chosen model. Omit it, or send default, and the session runs at the level recommended for that model, which is deliberately not always the provider's own: on gpt-5.6-terra it is none where the provider would use medium.

Response Body

`application/json`

curl -X POST "https://example.com/v3/sessions" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "status": "string",  "model": "string",  "title": "string",  "output": null,  "outputSchema": {},  "stepCount": 0,  "lastStepSummary": "string",  "isTaskSuccessful": true,  "liveUrl": "string",  "recordingUrls": [],  "profileId": "string",  "workspaceId": "string",  "proxyCountryCode": "string",  "maxCostUsd": "string",  "totalInputTokens": 0,  "totalOutputTokens": 0,  "llmCostUsd": "0",  "proxyCostUsd": "0",  "browserCostUsd": "0",  "proxyUsedMb": "0",  "totalCostUsd": "0",  "screenshotUrl": "string",  "reasoningEffort": "default",  "failureKind": "string",  "failureStatusCode": 0,  "agentmailEmail": "string",  "integrationsUsed": [],  "createdAt": "string",  "updatedAt": "string"}

Create Session

Authorization

Header Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`