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

Overview

This endpoint returns one session by its ses_ id. Poll it to follow a batch session from pending to running and then to completed, failed, or cancelled.

Request

string
required
Session ses_ id.

Response

Returns the session, with the same fields as Create Session returns.
string
required
The session’s ses_ id.
string
required
The deployment the session runs in.
string
required
Where the session is in its lifecycle: pending, running, completed, failed, or cancelled.
string
The job running a batch session, once it has been dispatched; null before that and for a serving session.
string
Why the session failed, or why the platform cancelled it; null otherwise.
object
The session’s own values; null when it has none. v2.0.1+

How a serving session ends on its own

Besides being cancelled or ended with its deployment, a serving session can end on its own. Its status and error then say how:

Important Notes

  • A 404 means the session does not exist, belongs to another organization, or is in a project you cannot see.