Session endpoints

Endpoints relating to sessions (active instances that support WebSockets)

Getting a session

GET /sessions/:session_id

Params:

Key	Description
session_id	The sessions id

Response:

success

{
  "success": true,
  "session": {
    "id": "SESSION_ID",
    "user_key": "USER_KEY" OR null,
    "script_id": "SCRIPT_ID",
    "roblox_id": 10373477521,
    "place_id": 606849621,
    "job_id": "JOB_ID",
    "created_at": 1770624500000
  }
}

Disconnecting a session

POST /sessions/:session_id/disconnect

Params:

Key	Description
session_id	The sessions id

Response:

success

{ "success": true }

Messaging a session

POST /sessions/:session_id/message

Check out Session commands for how to make your script handle messages

Request will wait up to 60 seconds for a response from the client

Params:

Key	Description
session_id	The sessions id

Payload:

Key	Type	Required
key	`String`	`True`
data	`JSON`	`False`

Response:

success (processed) success (not processed)

{
  "success": true,
  "processed": true,
  "response": {} OR null // json returned from client
}

{
  "success": true,
  "processed": false,
  "reason": "function errored, message: ..." OR "invalid return data" OR "client never responded" OR "function doesnt exist" OR "failed to communicate to client"
}

Disconnecting multiple session

POST /sessions/disconnect

Payload:

Key	Type	Required
session_ids	`Array<String>`	`True`

Response:

success

{ "success": true }

Messaging multiple session

POST /sessions/message

Check out Session commands for how to make your script handle messages

Request will wait up to 60 seconds for a response from the client

Payload:

Key	Type	Required
session_ids	`Array<String>`	`True`
key	`String`	`True`
data	`JSON`	`False`

Response:

success

{
  "success": true,
  "responses": [{
    "processed": true,
    "response": {} OR null // json returned from client
  }, {
    "processed": false,
    "reason": "function errored, message: ..." OR "invalid return data" OR "client never responded" OR "function doesnt exist" OR "failed to communicate to client"
  }]
}

Session endpoints Getting a session Disconnecting a session Messaging a session Disconnecting multiple session Messaging multiple session