Skip to main content
POST

Authorizations

Authorization
string
header
required

A Reactor API key (rk_...), sent as Authorization: Bearer rk_.... Keep it on a server.

Headers

Reactor-API-Version
string

The API protocol version the client speaks. Currently 1. Older versions than the server's minimum get 426.

Example:

"1"

Body

application/json
model
object
required
client_info
object

The SDK the client uses. Optional, and recorded for diagnostics.

extra_configs
object

Free-form string values passed to the model unchanged. The keys below have defined meanings; any other key is for the model to interpret.

Response

The session was created.

session_id
string<uuid>
required
state
enum<string>
required

The session's lifecycle state.

Available options:
CREATED,
PENDING,
WAITING,
SUSPENDED,
ACTIVE,
INACTIVE,
CLOSED
model
object
server_info
object
cluster
string

An opaque placement ID. Not an address.

zone
string

The Reactor region serving the session, such as us-west. Omitted when unknown.