View on GitHub

Gym Server Documentation

Information about Gym Server design and its API

Request Error Codes

Universal request error codes for Gym Server

These error codes only come when requesting Experiment resources through HTTP REST or WebSocket endpoints.

Resource endpoints use mostly standard convention for response status codes:

Errors for requests to resource endpoints follow this format:

{
  "errorCode": 100,
  "message": "Unknown server error. Try again later." 
}

TODO: Centralize API documentation for endpoints

experiment

Error code 1

Returned when an experiment encounters an unrecoverable error.

experimentUnknown

Error code 10

Returned when the given experiment_id for an operation does not exist.

unknown

Error code 100

Returned when the server does not know went wrong.