Skip to main content
POST
Expire a session

Authorizations

Authorization
string
header
required

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

Path Parameters

session_id
string
required

The session’s code, e.g. K7QM-24XP.

Response

The session, as it is now

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. disconnected: its computer went offline, or the team disconnected it. expired: unused for 72 hours, or expired by the team; the code and token no longer work.

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

When the code expires if it stays unused (null while connected), or when it was expired.

task_count
integer
latest_task_id
string | null