`ErrorResponse`

Fields

errorobjectrequiredErrorBody ↗

Show 4 nested fields

codeenumrequired

invalid_requestunauthenticatedpermission_deniednot_foundconflictrate_limitedunavailableinternal

detailsarray of objectoptionalErrorDetail ↗

Show 6 nested fields

fieldstringoptional

messagestringoptional

reasonenumoptional

api_key_expiredapi_key_inactiveapi_key_invalidapi_key_revokedjob_not_found

retry_after_msintegeroptional

typestringrequired

valueobjectoptional

messagestringrequired

request_idstringrequired

JSON Schema

ErrorResponse.json

{
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "description": "A URL to the JSON Schema for this object.",
      "examples": [
        "https://api.veed.io/schemas/ErrorResponse.json"
      ],
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "error": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "invalid_request",
            "unauthenticated",
            "permission_denied",
            "not_found",
            "conflict",
            "rate_limited",
            "unavailable",
            "internal"
          ],
          "type": "string"
        },
        "details": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "field": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "reason": {
                "enum": [
                  "api_key_expired",
                  "api_key_inactive",
                  "api_key_invalid",
                  "api_key_revoked",
                  "job_not_found"
                ],
                "type": "string"
              },
              "retry_after_ms": {
                "format": "int64",
                "type": "integer"
              },
              "type": {
                "type": "string"
              },
              "value": {}
            },
            "required": [
              "type"
            ],
            "type": "object"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message",
        "request_id"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}