Skip to content

Error Codes

The AutoVio API returns a consistent Error object in JSON for error responses. This page summarizes the error schema and where it is used.

Defined in the OpenAPI document (components.schemas.Error):

{
"error": "Resource not found",
"details": "The requested project does not exist"
}
FieldTypeDescription
errorstringShort error message (e.g. "Resource not found", "Invalid credentials").
detailsstringOptional additional details about the error.

All error responses that reference #/components/schemas/Error use this structure.

From the OpenAPI document and architecture:

StatusMeaningExample causes
400Bad RequestInvalid body, ID mismatch, missing required header.
401UnauthorizedMissing or invalid JWT/API token.
404Not FoundProject, work, template, asset, or scene not found.
409ConflictEmail already exists on register.

Each endpoint documents which status codes it can return and when it uses the Error schema.

  • Invalid credentials (login):

    • Status: 401
    • Body:
    {
    "error": "Invalid credentials",
    "details": "Email or password is incorrect"
    }
  • Project not found:

    • Status: 404
    • Body:
    {
    "error": "Resource not found",
    "details": "The requested project does not exist"
    }
  • Check the HTTP status code to differentiate auth errors, validation errors, and missing resources.
  • Use the error field for user-facing messages.
  • Use the details field for logs or debugging.