Skip to content

Error Handling & Response Schema ​

OneASR returns standard HTTP status codes along with OpenAI-compatible JSON error bodies.


Error Response Format ​

json
{
  "error": {
    "message": "Invalid API key provided.",
    "type": "invalid_request_error",
    "param": null,
    "code": "invalid_api_key"
  }
}

Common HTTP Status Codes ​

Status CodeCode / TypeDescription
200 OK-Request succeeded.
400 Bad Requestinvalid_request_errorMissing required parameters or unsupported audio format.
401 Unauthorizedinvalid_api_keyMissing or incorrect API key in Authorization header.
404 Not Foundnot_found_errorRequested task ID or model was not found.
422 Unprocessablevalidation_errorMultipart form schema validation failed.
500 Internal Serverserver_errorASR inference worker error or out-of-memory exception.