SIMIEN Simien Central APIAPI reference

Error codes

Every error is {"error": {"code", "message", "request_id"}}. Branch on code, not on the message, and quote request_id when you contact support.

CodeStatusMeaning
MISSING_API_KEY401No Authorization: Bearer header was sent
INVALID_API_KEY401The API key is not valid
API_KEY_EXPIRED401The API key has expired
CUSTOMER_SUSPENDED403The account is suspended
VALIDATION_ERROR422A required field is missing or has the wrong type; see details
RATE_LIMIT_EXCEEDED429Too many requests; wait Retry-After seconds
INVALID_REQUEST400The simulation service rejected the request, e.g. a bad version or file
SIMX_DECRYPT_FAILED400The .simx file could not be decrypted
SIMX_KEYS_UNAVAILABLE502The .simx decryption keys could not be loaded; retry later
FILE_UNREADABLE400The building file could not be read
PARAMETERS_INVALID400The simulatable-parameters document is not valid JSON or has no source.sha256
PARAMETERS_WRONG_BUILDING400The simulatable-parameters document was made from a different building
PARAMETERS_REJECTED400One or more changes cannot be applied; see message.problems
SIMULATION_REJECTED400The simulation engine rejected the file or settings, e.g. an unknown location
SXO_UNREADABLE400The uploaded file could not be read as a SIMIEN .sxo result
FILE_TOO_LARGE413The uploaded file is larger than the size limit
ALL_SIMULATIONS_FAILED502Every simulation in simulate-all failed
SIMULATION_TIMEOUT504The simulation engine did not respond in time; retry later
SIMULATION_SERVICE_UNAVAILABLE502The simulation engine is unavailable; retry later
UPSTREAM_UNAVAILABLE502The simulation service could not be reached; retry later
UPSTREAM_ERROR502The simulation service failed; retry later
UPSTREAM_AUTH_FAILED502The gateway could not authenticate with the simulation service; contact us
INTERNAL_ERROR500Unexpected error; contact us with the request_id