Portal
SandboxAPI v1Not signed inExternal user: —

TypeScript errors

classDiagram Error <|-- FoodAPIError FoodAPIError <|-- AuthenticationError FoodAPIError <|-- RateLimitError FoodAPIError <|-- ValidationError FoodAPIError <|--…
PythonTypeScript
classDiagram
    Error <|-- FoodAPIError
    FoodAPIError <|-- AuthenticationError
    FoodAPIError <|-- RateLimitError
    FoodAPIError <|-- ValidationError
    FoodAPIError <|-- NotFoundError
    FoodAPIError <|-- ServerError

API reference: errors.md

FoodAPIError

Base error. Fields: status, requestId, body.

AuthenticationError

Thrown on 401 and 403.

RateLimitError

Thrown on 429. Read retryAfterSeconds.

ValidationError

Thrown on 400 and 422. Inspect body for field errors.

NotFoundError

Thrown on 404.

ServerError

Thrown on 5xx after retry policy exhausts.

Catching

import {
  FoodAPI,
  RateLimitError,
  ValidationError,
} from "@foodapi/sdk";

try {
  await client.recipes.get("not-a-uuid");
} catch (err) {
  if (err instanceof ValidationError) console.error(err.body);
  if (err instanceof RateLimitError) console.error(err.retryAfterSeconds);
  throw err;
}