Get Session Group
const url = 'https://example.com/api/v1/org/example/ws/example/sessions/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?archived=active&include_workload_sessions=false';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/org/example/ws/example/sessions/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?archived=active&include_workload_sessions=false' \ --header 'Authorization: Bearer <token>'Get one visible session group and its child sessions.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Organization slug
Organization slug
Workspace slug
Workspace slug
Query Parameters
Section titled “Query Parameters ”Session-state filter for child sessions.
Session-state filter for child sessions.
Include workload-origin sessions.
Include workload-origin sessions.
Responses
Section titled “ Responses ”Successful Response
One visible session group plus its child sessions.
object
Visible rollup for one session group.
object
Session response for list and detail views.
object
Small denormalized view of a user attached to a session.
Used for both the creator (created_by, from the eager-loaded
SessionORM.user) and the sharer (shared_by, from
SessionORM.shared_by_user) — the role is carried by the field name, not
the type. The user’s id is embedded here alongside their email, so clients
render attribution without a follow-up request. Only the creator has a
separate raw id on the session (user_id); shared_by.id is the
sharer’s only id on the wire.
Visible rollup for one session group.
object
Labels attached to this session as {key: [value, ...]}.
object
Session origin (SES-ORG-001). user for interactive sessions, eval for evaluation-worker sessions, worker for capability-worker sessions.
Small denormalized view of a user attached to a session.
Used for both the creator (created_by, from the eager-loaded
SessionORM.user) and the sharer (shared_by, from
SessionORM.shared_by_user) — the role is carried by the field name, not
the type. The user’s id is embedded here alongside their email, so clients
render attribution without a follow-up request. Only the creator has a
separate raw id on the session (user_id); shared_by.id is the
sharer’s only id on the wire.
Aggregated token usage for a session.
All fields are derived at read time from per-message usage columns on
session_messages. Pre-migration sessions (no usage data) report
zeros; new sessions with no inference yet report zeros and
last_generation_input_tokens=None.
object
Non-compacted message count — the subset the transcript paginates. current means the current era (consistent with the other current_* usage fields), NOT a pagination page; it diverges from total_message_count once the session has been compacted.
Lifetime message count — every message, compacted included.
Example
{ "group": { "kind": "worker_run", "status": "running" }, "sessions": [ { "frozen_by": "evaluation", "group": { "kind": "worker_run", "status": "running" }, "origin": "user", "visibility": "private" } ]}Invalid request
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Authentication failed
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Access forbidden
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Not found
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Already exists
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Validation error
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Upgrade required
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Rate limited
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Internal server error
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Bad gateway
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}Gateway timeout
Canonical API error envelope returned by the API.
object
HTTP status code
Human-readable error message
object
Where the validation error occurred
Human-readable validation message
Machine-readable validation error type
Stable machine-readable error type
Example
{ "code": 401, "detail": "Authentication failed", "type": "authentication_error"}