OpenBrowse
v3 API referencev3/sessions/session_id/stop

Stop Session

Cancel a running session and close its browser. The default leaves it stopped; strategy "task" leaves it idle, so a later call can give it new work.

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

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

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Path Parameters

session_id*Session Id

Header Parameters

x-browser-use-api-key?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v3/sessions/string/stop" \  -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"}