Skip to content

Create a new session​

POST
/v1/sessions

Allocates a board of the requested type and starts a new session. With base_image_id the coordinator fetches that image and has the pod write it before the user touches the board; the image is resolved before a board is taken, so a wrong or unreachable one costs neither a board nor a credit.

Authorizations​

BearerAuth

API key (Bearer key_...)

Type
API Key (header: Authorization)

Request Body​

application/json
JSON
{
  
"base_image_id": "string",
  
"board_type": "string"
}

Responses​

Created

application/json
JSON
{
  
"base_image_id": "string",
  
"board_id": "string",
  
"board_specs": "string",
  
"board_type": "string",
  
"created_at": "string",
  
"credits_used": 0,
  
"end_reason": "string",
  
"ended_at": "string",
  
"id": "string",
  
"started_at": "string",
  
"state": "string",
  
"user_id": "string"
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI