POST
Register a session playbook
Register or replace a login playbook (site URL + ordered browser actions) for a session. The orchestrator can replay this playbook automatically when it detects expired cookies.

Request parameters (JSON body)

Required

  • site (string): Login/start URL for the site you want to authenticate against.
  • actions (array, min 1): Ordered browser interactions to perform on site.

Action object

  • action (string, required): click, type, scroll, wait, select
  • selector (string | null): Element selector (if applicable)
  • selector_type (string, default: css): css, xpath, role, text, regex, test_id, label, placeholder
  • value (string | null): Input text / scroll amount / wait ms (depends on action)

Optional

  • session_id (string | null): Provide to update/replace an existing playbook. If omitted, a new random ID is generated and returned.

Responses

  • 200: The stored playbook echoed back with its assigned session_id.
  • 422: Validation error (invalid site URL or empty actions list).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Register or replace a session playbook (login URL + actions) for automatic replay after cookie clears.

site
string
required
Examples:

"https://app.example.com/login"

"https://dashboard.example.com"

actions
ActionModel · object[]
required
Minimum array length: 1
session_id
string | null
Example:

"my-session-abc123"

Response

The stored playbook echoed back with its assigned session ID

session_id
string
required
Example:

"my-session-abc123"

site
string
required
Example:

"https://app.example.com/login"

actions
ActionModel · object[]
required