{"openapi":"3.1.0","info":{"title":"OpenBrowse","version":"1.12.0"},"servers":[{"url":"http://localhost:8420","description":"A local OpenBrowse instance"},{"url":"https://{host}","description":"Your own instance, for example a Tailscale Funnel hostname","variables":{"host":{"default":"your-pi.tail0a1b2c.ts.net","description":"The hostname your instance is reachable on"}}}],"paths":{"/v3/profiles":{"post":{"tags":["profiles"],"summary":"Create Profile","description":"Create an empty profile, with no cookies and no per-origin storage yet. Fill it by importing a cookie jar, or by letting a session log in while using it.","operationId":"createProfile","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProfileCreateRequest"},{"type":"null"}],"title":"Body"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileView"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"get":{"tags":["profiles"],"summary":"List Profiles","description":"List profiles, paginated, with an optional query to narrow the results.","operationId":"listProfiles","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":20,"title":"Page Size"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileListResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v3/profiles/{profile_id}":{"get":{"tags":["profiles"],"summary":"Get Profile","description":"Fetch a single profile by id. Returns 404 if no profile has that id.","operationId":"getProfile","security":[{"HTTPBearer":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileView"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"put":{"tags":["profiles"],"summary":"Update Profile","description":"Update a profile's editable fields. PUT and PATCH behave identically here: both apply only the fields present in the request body.","operationId":"updateProfile","security":[{"HTTPBearer":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileView"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"patch":{"tags":["profiles"],"summary":"Update Profile","description":"Update a profile's editable fields. PUT and PATCH behave identically here: both apply only the fields present in the request body.","operationId":"patchProfile","security":[{"HTTPBearer":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileView"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"delete":{"tags":["profiles"],"summary":"Delete Profile","description":"Delete a profile and the browser state stored against it. The cookies and per-origin storage go with it.","operationId":"deleteProfile","security":[{"HTTPBearer":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v3/profiles/{profile_id}/storage-state":{"put":{"tags":["profiles"],"summary":"Put Storage State","description":"Import a cookie jar into a profile, creating the profile if it does not exist yet.","operationId":"putProfileStorageState","security":[{"HTTPBearer":[]}],"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","title":"Profile Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageStateBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileView"}}}},"400":{"description":"Invalid storage state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v3/sessions":{"post":{"tags":["sessions"],"summary":"Create Session","description":"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.","operationId":"createSession","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/RunTaskRequest"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"get":{"tags":["sessions"],"summary":"List Sessions","description":"List sessions with their current status, paginated. Running and finished sessions are both included.","operationId":"listSessions","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Page Size"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionListResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v3/sessions/{session_id}":{"get":{"tags":["sessions"],"summary":"Get Session","description":"Fetch one session by id, with its status, step count, live view URL and structured output as they stand right now.","operationId":"getSession","security":[{"HTTPBearer":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"delete":{"tags":["sessions"],"summary":"Delete Session","description":"Cancel the session if it is still running, then delete it and everything stored against it.","operationId":"deleteSession","security":[{"HTTPBearer":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v3/sessions/{session_id}/messages":{"get":{"tags":["sessions"],"summary":"List Messages","description":"Read the messages a session has produced, paged with after, before and limit, for following a run live or diagnosing one afterwards.","operationId":"listSessionMessages","security":[{"HTTPBearer":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageListResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Request validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v3/sessions/{session_id}/stop":{"post":{"tags":["sessions"],"summary":"Stop Session","description":"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.","operationId":"stopSession","security":[{"HTTPBearer":[]}],"parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"x-browser-use-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Browser-Use-Api-Key"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/StopSessionRequest"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"Authentication attempts are rate limited.","headers":{"Retry-After":{"description":"Seconds until authentication may be retried.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}},"components":{"schemas":{"ErrorEnvelope":{"properties":{"code":{"type":"string","title":"Code","description":"Stable machine-readable error code."},"message":{"type":"string","title":"Message","description":"Human-readable summary of the error."},"resolution":{"type":"string","title":"Resolution","description":"Action the caller can take to resolve the error."},"detail":{"title":"Detail","description":"Legacy error detail retained for compatibility."}},"type":"object","required":["code","message","resolution","detail"],"title":"ErrorEnvelope"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MessageListResponse":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/MessageResponseModel"},"type":"array","title":"Messages"},"hasMore":{"type":"boolean","title":"Hasmore"}},"type":"object","required":["messages","hasMore"],"title":"MessageListResponse"},"MessageResponseModel":{"properties":{"id":{"type":"string","title":"Id"},"sessionId":{"type":"string","title":"Sessionid"},"role":{"type":"string","title":"Role"},"data":{"type":"string","title":"Data"},"type":{"type":"string","title":"Type"},"summary":{"type":"string","title":"Summary"},"screenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screenshoturl","description":"Always null. OpenBrowse does not capture end-of-session screenshots."},"hidden":{"type":"boolean","title":"Hidden","default":false},"createdAt":{"type":"string","title":"Createdat"}},"type":"object","required":["id","sessionId","role","data","type","summary","createdAt"],"title":"MessageResponseModel"},"ProfileCreateRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"userId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"}},"type":"object","title":"ProfileCreateRequest"},"ProfileListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProfileView"},"type":"array","title":"Items"},"totalItems":{"type":"integer","title":"Totalitems"},"pageNumber":{"type":"integer","title":"Pagenumber"},"pageSize":{"type":"integer","title":"Pagesize"}},"type":"object","required":["items","totalItems","pageNumber","pageSize"],"title":"ProfileListResponse"},"ProfileUpdateRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"userId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"}},"type":"object","title":"ProfileUpdateRequest"},"ProfileView":{"properties":{"id":{"type":"string","title":"Id"},"userId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"lastUsedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastusedat"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"cookieDomains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cookiedomains"}},"type":"object","required":["id","createdAt","updatedAt"],"title":"ProfileView"},"RunTaskRequest":{"properties":{"task":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task"},"model":{"type":"string","title":"Model","description":"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":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sessionid"},"keepAlive":{"type":"boolean","title":"Keepalive","default":false},"maxCostUsd":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}],"title":"Maxcostusd"},"profileId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profileid"},"outputSchema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Outputschema"},"sensitiveData":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Sensitivedata"},"systemPromptExtension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Systempromptextension"},"skills":{"type":"boolean","title":"Skills","default":true,"description":"Accepted for compatibility with browser-use-sdk and ignored."},"enableRecording":{"type":"boolean","title":"Enablerecording","default":false,"description":"Accepted for compatibility with browser-use-sdk and ignored. OpenBrowse does not record sessions, and recordingUrls comes back empty. Use the live view instead."},"proxyCountryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxycountrycode","description":"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":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoningeffort","description":"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."}},"type":"object","title":"RunTaskRequest"},"SessionListResponse":{"properties":{"sessions":{"items":{"$ref":"#/components/schemas/SessionResponse"},"type":"array","title":"Sessions"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"pageSize":{"type":"integer","title":"Pagesize"}},"type":"object","required":["sessions","total","page","pageSize"],"title":"SessionListResponse"},"SessionResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"type":"string","title":"Status"},"model":{"type":"string","title":"Model"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"output":{"anyOf":[{},{"type":"null"}],"title":"Output"},"outputSchema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Outputschema"},"stepCount":{"type":"integer","title":"Stepcount","default":0},"lastStepSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Laststepsummary"},"isTaskSuccessful":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Istasksuccessful","description":"Whether the run delivered the result that was asked for: it reached the end and, when an output schema was given, returned a value matching it. It is not a judgement of the content. A page behind a paywall, a field the site does not publish and an agent that doubts its own work all still count as delivered, with null or partial values in the output saying what could not be obtained; deciding whether that is good enough is the caller's. False means nothing was delivered: the run stopped early, ran out of steps, or returned a value that did not match the schema."},"liveUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Liveurl"},"recordingUrls":{"items":{"type":"string"},"type":"array","title":"Recordingurls","default":[],"description":"Always empty. OpenBrowse does not record sessions."},"profileId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profileid"},"workspaceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspaceid","description":"Always null. OpenBrowse has no workspace concept."},"proxyCountryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxycountrycode","description":"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."},"maxCostUsd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Maxcostusd"},"totalInputTokens":{"type":"integer","title":"Totalinputtokens","default":0},"totalOutputTokens":{"type":"integer","title":"Totaloutputtokens","default":0},"llmCostUsd":{"type":"string","title":"Llmcostusd","default":"0"},"proxyCostUsd":{"type":"string","title":"Proxycostusd","default":"0"},"browserCostUsd":{"type":"string","title":"Browsercostusd","default":"0"},"proxyUsedMb":{"type":"string","title":"Proxyusedmb","default":"0"},"totalCostUsd":{"type":"string","title":"Totalcostusd","default":"0"},"screenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screenshoturl","description":"Always null. OpenBrowse does not capture end-of-session screenshots."},"reasoningEffort":{"type":"string","title":"Reasoningeffort","default":"default"},"failureKind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failurekind"},"failureStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failurestatuscode"},"agentmailEmail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agentmailemail"},"integrationsUsed":{"items":{"type":"string"},"type":"array","title":"Integrationsused","default":[]},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"}},"type":"object","required":["id","status","model","createdAt","updatedAt"],"title":"SessionResponse"},"StopSessionRequest":{"properties":{"strategy":{"type":"string","title":"Strategy","default":"session"}},"type":"object","title":"StopSessionRequest"},"StorageStateBody":{"properties":{"cookies":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Cookies","default":[]},"origins":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Origins","default":[]}},"type":"object","title":"StorageStateBody"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"},"HTTPBasic":{"type":"http","scheme":"basic"}}}}