API · errors

Errors

Scrwly uses one structured error shape across the versioned API. Every error includes a machine code and a request id.

Shape

{
  "error": {
    "code": "invalid_scene",
    "message": "The scene failed validation.",
    "requestId": "req_abc123",
    "details": {
      "issues": [
        {
          "path": "canvas.width",
          "code": "invalid_type",
          "message": "Required",
          "severity": "error"
        }
      ]
    }
  }
}

Status codes

StatusMeaning
400Invalid request
401Missing or invalid key
403Provider not allowed on this plan
404Not found
413Prompt too large
422Invalid scene
429Rate limited
500Internal error