Error

Forma de la respuesta de error

Todos los endpoints devuelven errores en esta envoltura unificada.

{
  "success": false,
  "error": {
    "code":    "INVALID_URL",
    "status":  400,
    "message": "The provided URL is not valid",
    "details": null
  }
}

Campos

• success (boolean): siempre false para errores
• error.code (string): código de error legible por máquina — ver Códigos de error
• error.status (number): código de estado HTTP (refleja el estado de la respuesta; útil cuando el estado bruto no está disponible)
• error.message (string): descripción legible del error
• error.details (object | null): contexto estructurado del error — por ejemplo, errores de validación a nivel de campo como pares { field: message } devueltos en INVALID_PARAMETER; null cuando no aplica

Tipo TypeScript

type ErrorResponse = {
  success: false;
  error: {
    code: string;       // machine-readable, e.g. "INVALID_URL"
    status: number;     // HTTP status code
    message: string;    // human-readable
    details: Record<string, unknown> | null;
  };
};

Contrato estable: estos 4 campos error.* están garantizados. Las adiciones futuras serán retrocompatibles — los clientes pueden ignorar campos desconocidos con seguridad.