Enum ApiError 

pub enum ApiError {
    BadRequest(String),
    Unauthorized,
    Forbidden(String),
    NotFound(String),
    Conflict(String),
    Validation(ValidationDetails),
    LoginBadCredentials,
    LoginUserNotVerified,
    RegisterUserAlreadyExists,
    RegisterInvalidPassword(String),
    ResetPasswordBadToken,
    ResetPasswordInvalidPassword(String),
    VerifyUserBadToken,
    VerifyUserAlreadyVerified,
    UpdateUserEmailAlreadyExists,
    UpdateUserInvalidPassword(String),
    ApiKeyEnvelope(String),
    PipelineErrored {
        pipeline_source: PipelineErrorSource,
        run_info: Value,
    },
    Teapot(String),
    WriteEndpointError {
        error: String,
        detail: Option<String>,
        status: StatusCode,
    },
    WriteEnvelopeError(String, StatusCode),
    ErrorMessageError(String, StatusCode),
    OntologyEnvelope(String, StatusCode),
    DeprecatedConflict(String),
    NotImplemented(String),
    ServiceUnavailable(String),
    NotImplementedStub {
        code: &'static str,
        detail: &'static str,
    },
    SearchError {
        status: StatusCode,
        error: String,
        detail: Option<String>,
    },
    RecallError {
        status: StatusCode,
        body: RecallErrorBody,
    },
    LlmError(StatusCode, String),
    VisualizeError(StatusCode, String),
    Internal(Error),
}

HTTP-layer error type. Every handler returns Result<T, ApiError> and the IntoResponse impl maps variants to the Python-compatible JSON envelopes.

Variants

BadRequest(String)

400 {"detail": "..."} — generic bad-request condition.

Unauthorized

401 {"detail": "Unauthorized"}.

Forbidden(String)

403 {"detail": "..."}.

NotFound(String)

404 {"detail": "..."}.

Conflict(String)

409 {"detail": "..."}.

Validation(ValidationDetails)

400 {"detail": [...], "body": ...} — serde/Pydantic-style validation.

LoginBadCredentials

400 {"detail": "LOGIN_BAD_CREDENTIALS"} — fastapi-users compat.

LoginUserNotVerified

400 {"detail": "LOGIN_USER_NOT_VERIFIED"} — fastapi-users compat.

RegisterUserAlreadyExists

400 {"detail": "REGISTER_USER_ALREADY_EXISTS"} — fastapi-users compat.

RegisterInvalidPassword(String)

400 {"detail": {"code": "REGISTER_INVALID_PASSWORD", "reason": "..."}}.

ResetPasswordBadToken

400 {"detail": "RESET_PASSWORD_BAD_TOKEN"} — fastapi-users compat.

ResetPasswordInvalidPassword(String)

400 {"detail": {"code": "RESET_PASSWORD_INVALID_PASSWORD", "reason": "..."}}.

VerifyUserBadToken

400 {"detail": "VERIFY_USER_BAD_TOKEN"} — fastapi-users compat.

VerifyUserAlreadyVerified

400 {"detail": "VERIFY_USER_ALREADY_VERIFIED"} — fastapi-users compat.

UpdateUserEmailAlreadyExists

400 {"detail": "UPDATE_USER_EMAIL_ALREADY_EXISTS"} — fastapi-users compat.

UpdateUserInvalidPassword(String)

400 {"detail": {"code": "UPDATE_USER_INVALID_PASSWORD", "reason": "..."}}.

ApiKeyEnvelope(String)

400 {"error": {"message": "..."}} — unique envelope used ONLY by the api-keys router. Never use this variant outside routers/api_keys.rs.

PipelineErrored

420 (Improve) or 500 (all others) — pipeline job returned an error.

• pipeline_source = Improve → HTTP 420, body is the raw run_info value (Python’s /improve returns the PipelineRunInfo object directly, not the canonical envelope).
• all other sources → HTTP 500, body is {"error": "Pipeline run errored", "detail": "<msg>"}.

/remember does not use this variant — its catch-all is ApiError::DeprecatedConflict("An error occurred during remember.") per Python parity (produces {"error": "..."}, not {"detail": "..."}).

/improve’s generic catch-all similarly uses ApiError::DeprecatedConflict.

Note: the field is named pipeline_source (not source) to prevent thiserror from treating it as an error-chain source.

Fields

pipeline_source: PipelineErrorSource

run_info: Value

For Improve: the full serialised PipelineRunInfoDTO. For others: serde_json::json!({"error": "Pipeline run errored", "detail": "<msg>"}).

Teapot(String)

418 {"detail": "<msg>"} — Python fallback for uncategorized errors.

Changed from a unit variant to carry a message string for Python parity (datasets and add routers use this with dynamic messages).

WriteEndpointError

add/update error envelope: {"error": "...", "detail": "..."}.

Used only by routers/add.rs and routers/update.rs — the only routes that deviate from the canonical {"detail": "..."} shape.

Fields

error: String

detail: Option<String>

status: StatusCode

WriteEnvelopeError(String, StatusCode)

<status> {"error": "..."} — used by datasets 2.2 catch-all (409), datasets 2.6 (404), and datasets 2.8 (404).

ErrorMessageError(String, StatusCode)

<status> {"message": "..."} — used by datasets 2.3 (404).

OntologyEnvelope(String, StatusCode)

<status> {"error": "..."} — used by ontologies and forget.

DeprecatedConflict(String)

409 {"error": "..."} — used by the deprecated /delete endpoint and by the /remember and /improve catch-all error paths.

Python parity: those routers return JSONResponse({"error": "..."}) with status 409, not HTTPException(409, detail=...), so the body key is "error" rather than "detail". This is intentionally different from ApiError::Conflict which uses the "detail" key.

NotImplemented(String)

501 {"detail": "..."} — not implemented (e.g. unsupported storage scheme).

ServiceUnavailable(String)

503 {"error": "..."} — service unavailable.

Used by /api/v1/remember/entry when the session cache is not configured. Mirrors Python’s JSONResponse(status_code=503, content={"error": str(error)}) (get_remember_router.py:158-160).

NotImplementedStub

501 {"detail": "...", "code": "..."} — structured stub envelope.

Field order is wire-load-bearing: detail first, then code, matching Python’s JSONResponse({"detail": ..., "code": ...}) insertion order. Used by the notebooks /run stub and the responses stub.

Fields

code: &'static str

detail: &'static str

SearchError

<status> {"error": "<error>", "detail": "<detail>"} — used by /api/v1/search (403/422/500) and GET /api/v1/search (500). Mirrors Python’s ErrorResponse model.

Fields

status: StatusCode

error: String

detail: Option<String>

RecallError

Three-shaped envelope used only by /api/v1/recall.

• WithHint { error, hint } for 422 prerequisite errors.
• JustError { error } for the 409 catch-all and the GET-history 500.

Permission denied is NOT encoded here — the recall handler returns 200 [] directly without going through ApiError.

Fields

status: StatusCode

body: RecallErrorBody

LlmError(StatusCode, String)

<status> {"error": "<msg>"} — used by /api/v1/llm/* for 400/409/422.

VisualizeError(StatusCode, String)

<status> {"error": "<msg>"} — used by /api/v1/visualize/* for the 409 catch-all and the 403 superuser-only failure.

Internal(Error)

500 — unhandled internal error.

Trait Implementations

impl Debug for ApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ApiError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Create a response.