Skip to main content
POST
Create a session

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Body

application/json
agent_id
string

The agent to run. Defaults to default.

Example:

"billing"

metadata
object

Your own ids and labels (e.g. a ticket or customer id), returned as given.

Example:

Response

OK

object
any
session_id
string
Example:

"K7QM-24XP"

code
string
Example:

"K7QM-24XP"

agent_id
string
invite_url
string
Example:

"https://guidinghand.ai/acme/billing/K7QM-24XP"

status
enum<string>

waiting: no computer has used the code yet. connected: its computer is online now.

Available options:
waiting,
connected,
disconnected,
expired
device
object | null
metadata
object

Your own ids and labels (e.g. a ticket or customer id), returned as given.

Example:
created_at
string<date-time>
paired_at
string<date-time> | null
last_active_at
string<date-time>
expires_at
string<date-time> | null
task_count
integer
latest_task_id
string | null
session_token
string

A token for this one session (the older task API). Shown once.