Rensei docs
API ReferenceInteractive sessions

Get one interactive session's detail.

Authentication accepts a browser session or a WorkOS user token only; an rsk API key or a BYOA OAuth-agent token is rejected 403 (no user identity to derive driver/viewer capability from). Returns 404 - never 403 - for a session belonging to a different org or one the caller has no project access/grant for, so existence is never leaked across the boundary.

GET
/api/interactive-sessions/{id}

Authorization

AuthorizationBearer <token>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

In: header

Path Parameters

id*string

The session id (agent_sessions.session_id).

Response Body

application/json

curl -X GET "https://example.com/api/interactive-sessions/string"
{
  "id": "string",
  "sessionId": "string",
  "orgId": "string",
  "projectId": "string",
  "createdByUserId": "string",
  "status": "provisioning",
  "liveStatus": "string",
  "poolId": "string",
  "harness": "string",
  "modelProfileId": "string",
  "sandboxProvider": "string",
  "localAuthAvailable": true,
  "localAuthAvailableSource": "default",
  "displayName": "string",
  "executionLocation": {
    "provider": "string",
    "pool": {
      "id": "string",
      "displayName": "string"
    },
    "host": {
      "id": "string",
      "displayName": "string"
    },
    "sandboxFlavor": "string",
    "runtimeFlavor": "string"
  },
  "relayRoomId": "string",
  "sessionDetail": {
    "property1": null,
    "property2": null
  },
  "driverState": {
    "property1": null,
    "property2": null
  },
  "recordingPolicy": "string",
  "recordingPointer": "string",
  "callerRole": "driver",
  "startedAt": "string",
  "endedAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
Empty
Empty
Empty
Empty