Get a Session
curl "https://api.driver.dev/v1/browser/session?sessionId=$SESSION_ID" \
-H "Authorization: Bearer $DRIVER_API_KEY"
resp = requests.get(
"https://api.driver.dev/v1/browser/session",
headers={"Authorization": f"Bearer {os.getenv('DRIVER_API_KEY')}"},
params={"sessionId": os.getenv("SESSION_ID")},
)
print(resp.json())
const session = await client.browser.session.get({
sessionId: process.env.SESSION_ID!,
});
List Sessions
curl "https://api.driver.dev/v1/browser/sessions?page=1&pageSize=20&status=active" \
-H "Authorization: Bearer $DRIVER_API_KEY"
resp = requests.get(
"https://api.driver.dev/v1/browser/sessions",
headers={"Authorization": f"Bearer {os.getenv('DRIVER_API_KEY')}"},
params={"page": 1, "pageSize": 20, "status": "active"},
)
print(resp.json())
const sessions = await client.browser.session.list({
page: 1,
pageSize: 20,
status: "active",
});
Update a Session Note
Notes are updated after session creation.curl -X PATCH "https://api.driver.dev/v1/browser/session?sessionId=$SESSION_ID" \
-H "Authorization: Bearer $DRIVER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"note":"Scraping product pages"}'
resp = requests.patch(
"https://api.driver.dev/v1/browser/session",
headers={
"Authorization": f"Bearer {os.getenv('DRIVER_API_KEY')}",
"Content-Type": "application/json",
},
params={"sessionId": os.getenv("SESSION_ID")},
json={"note": "Scraping product pages"},
)
print(resp.json())
Stop a Session
Always stop sessions when your automation completes.curl -X DELETE "https://api.driver.dev/v1/browser/session?sessionId=$SESSION_ID" \
-H "Authorization: Bearer $DRIVER_API_KEY"
resp = requests.delete(
"https://api.driver.dev/v1/browser/session",
headers={"Authorization": f"Bearer {os.getenv('DRIVER_API_KEY')}"},
params={"sessionId": os.getenv("SESSION_ID")},
)
print(resp.json())
const result = await client.browser.session.stop({
sessionId: process.env.SESSION_ID!,
});
Session Statuses
| Status | Meaning |
|---|---|
starting | Session is being created. |
active | Session is running and can accept CDP connections. |
completed | Session has stopped successfully. |
error | Session failed or ended with an error. |