Skip to content

Sessions API

Create session

POST /sessions

Request:

{
"profile": "default",
"headless": true,
"url": "https://example.com"
}
FieldTypeDefaultDescription
profilestring"default"Chromium profile name
headlessbooleantrueRun without visible window
urlstringNavigate to this URL after launch

Response:

{
"id": "1",
"profile": "default",
"url": "https://example.com/",
"status": 200,
"snapshot": "h1 \"Example Domain\"\n[1] a \"More...\" href=\"...\""
}

If url is provided, the response includes the navigation result. Otherwise only id and profile are returned.


List sessions

GET /sessions

Response:

[
{"id": "1", "profile": "default", "headless": true, "pages": 1},
{"id": "2", "profile": "mysite", "headless": false, "pages": 2}
]

Delete session

DELETE /sessions/{sid}

Closes the browser context. Profile data is preserved.

Response:

{"deleted": "1"}