Skip to main content
GET
Requires version 2.0.1 or later of the Archetype platform.

Overview

This endpoint returns one of your sessions on a model by its ses_ ID. A session you can’t see returns 404, the same as one that doesn’t exist.

Request

string
required
Session ses_ ID.

Response

string
The session’s ses_ ID.
string
The name of the model the session is on, whichever of the model’s names opened it.
string
Where the session is in its lifecycle:
  • running: open and able to answer queries. A session is running from the moment it opens.
  • completed: ended without a fault, for example because it sat idle long enough to expire. error says why.
  • failed: ended by a fault, usually because the copy of the model holding it was lost during a release. error says why.
  • cancelled: ended by your cancel, or because the copy of the model holding it was replaced. In the second case, error says so.
object | null
The values the session was opened with, or null for none.
string | null
Why the platform ended the session, for example the session's replica was replaced. null while the session runs or when you cancelled it. Don’t parse it: open a new session when a call returns 409 with code session_not_running.
string
When the session was created (ISO 8601).
string | null
When the session started running (ISO 8601), or null until then.
string | null
When the session ended (ISO 8601), or null while it runs.

Important Notes

  • 404 means the session doesn’t exist or isn’t visible to you.
  • You see your own sessions. A service-account key sees the sessions of every service-account key in the organization, and an organization admin sees all of the organization’s.