Sessions

Update Session

Rename a session.

session_title is denormalized onto every run in the session (the session list reads the latest run), so a rename writes them all in one UPDATE. Null clears the name and the UI falls back to the opening task — it does NOT re-run title generation, which only fills rows where the title IS NULL and so would silently overwrite the clear.

patch/sessions/{session_id}

Request

  • Base URL: https://api.browser-use.com/api/v4
  • URL: https://api.browser-use.com/api/v4/sessions/{session_id}
  • Auth: API key in header X-Browser-Use-API-Key

Path parameters

session_idstring uuid required

Request body

titlestring nullable

Response

Successful Response

sessionIdstring uuid required
workspaceIdstring uuid nullable required
latestRunIdstring uuid required
taskstring required
titlestring nullable required
status'queued' | 'dispatching' | 'running' | 'completed' | 'failed' | 'cancelled' required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.