Skip to content

Códigos de error

Cuando una solicitud falla, la API devuelve una respuesta de error JSON con un code legible por máquinas y un message legible por humanos:

json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description of the error"
  }
}

El campo code es estable y seguro para usar en la lógica de tu aplicación. El campo message puede cambiar con el tiempo y está destinado a registro y depuración.

Referencia de códigos de error

CódigoEstado HTTPDescripciónReintentableResolución
UNAUTHORIZED401Token de autenticación faltante, inválido o expiradoNoVerifica que tu clave API sea válida y no haya expirado
KEY_EXPIRED401La clave API ha pasado su fecha de expiraciónNoCrea una nueva clave API en el panel de control o mediante la API
FORBIDDEN403Autenticado pero no autorizado para este recursoNoSolo puedes acceder a tus propios recursos
NOT_FOUND404El recurso solicitado no existeNoVerifica que el ID del recurso sea correcto
VALIDATION_ERROR400El cuerpo de la solicitud no pasó la validación del esquemaNoVerifica que los campos requeridos y los tipos de datos coincidan con el esquema
INVALID_MIME_TYPE400El archivo subido tiene un tipo MIME no compatibleNoUsa un tipo de archivo compatible (PDF o DOCX)
FILE_TOO_LARGE400El archivo subido excede el límite de tamaño de 10 MBNoReduce el tamaño del archivo o divídelo en documentos más pequeños
MAX_KEYS_REACHED400Se alcanzó el máximo de 10 claves API activasNoRevoca claves no utilizadas antes de crear nuevas
USAGE_LIMIT_EXCEEDED429Se alcanzó el límite mensual de extraccionesNoMejora tu plan o espera al próximo período de facturación
INTERNAL_ERROR500Error inesperado del servidorReintenta con retroceso exponencial. Si persiste, contacta con soporte
NOT_CONFIGURED501Un servicio requerido del lado del servidor no está configuradoNoContacta con soporte -- esto indica un problema de configuración del servidor
EXTRACTION_FAILED502El procesamiento de extracción con IA fallóReintenta -- puede ser un problema transitorio. Verifica que el PDF sea válido y legible
EXTRACTION_PARSE_ERROR502La IA devolvió una respuesta que no pudo ser parseada como JSONReintenta -- la IA puede producir una salida válida en un intento posterior

Errores reintentables

Solo los siguientes códigos de error deben reintentarse:

  • INTERNAL_ERROR -- Un fallo inesperado en el lado del servidor.
  • EXTRACTION_FAILED -- El proceso de extracción con IA falló, a menudo debido a problemas transitorios.
  • EXTRACTION_PARSE_ERROR -- La IA devolvió una salida mal formada que no pudo ser parseada.

Al reintentar, usa retroceso exponencial comenzando en 1 segundo, con un máximo de 3 reintentos:

IntentoRetardo
1er reintento1 segundo
2do reintento2 segundos
3er reintento4 segundos

Si la solicitud sigue fallando después de 3 reintentos, registra el error y notifícalo al usuario o a tu sistema de monitoreo.

Para una guía completa sobre la implementación de lógica de reintentos, consulta Manejo de errores.

Resumen de códigos de estado HTTP

EstadoSignificado
200Éxito -- la solicitud se completó correctamente
400Solicitud incorrecta -- error de validación, tipo de archivo inválido, archivo demasiado grande o límite de claves alcanzado
401No autorizado -- la autenticación falló (token faltante, inválido o expirado)
403Prohibido -- autenticado pero no autorizado para el recurso solicitado
404No encontrado -- el recurso solicitado no existe
429Demasiadas solicitudes -- se excedió el límite de uso mensual de extracciones
500Error interno del servidor -- fallo inesperado en el lado del servidor
501No implementado -- un servicio requerido del lado del servidor no está configurado
502Bad Gateway -- la extracción o el parseo con IA falló

Documentación de la API de DocMap