Docs — API Reference

Errors

Every non-2xx response carries the same envelope: a stable machine code, a human message, a doc_url, and — for validation failures — a per-field errors object. Codes are the contract; messages may improve, codes never change semantics. The full table with remediation lives at /docs/errors.

[ 01 ]get/v1/errors

GET/v1/errors

Machine-readable catalog of every error code — useful for generating client enums.

[ response ]200 ok
{
  "object": "list",
  "data": [
    { "status": 400, "code": "invalid_request",  "retriable": false },
    { "status": 401, "code": "unauthenticated",  "retriable": false },
    { "status": 403, "code": "scope_denied",     "retriable": false },
    { "status": 404, "code": "not_found",        "retriable": false },
    { "status": 422, "code": "step_limit",       "retriable": false },
    { "status": 429, "code": "rate_limited",     "retriable": true  },
    { "status": 500, "code": "internal",         "retriable": true  },
    { "status": 503, "code": "overloaded",       "retriable": true  }
  ]
}

[ 02 ]get/v1/errors/:code

GET/v1/errors/:code

Retrieve one code with its description and remediation text.

paramtypereqdescription
codestringrequiredError code, e.g. scope_denied. Path parameter.
[ response ]200 ok
{
  "code": "scope_denied",
  "status": 403,
  "retriable": false,
  "description": "A fetch or action exceeded the key's scopes.",
  "remediation": "Grant the scope named in the error message, or remove the context source from the request.",
  "doc_url": "https://myndlabs.ai/docs/errors#scope_denied"
}

More resources