Web Analytics Made Easy - Statcounter
Skip to content

Referencia de la API

Documentaci贸n completa de la API backend de Duckling.

URL base

http://localhost:5001/api

Autenticaci贸n

Por ahora la API no requiere autenticaci贸n. En entornos de producci贸n, considere a帽adir un middleware de autenticaci贸n.

Secciones

Referencia r谩pida

Endpoints de conversi贸n

Endpoint M茅todo Descripci贸n
/convert POST Subir y convertir un documento
/convert/batch POST Convertir varios documentos por lotes
/convert/{job_id}/status GET Obtener el estado de la conversi贸n
/convert/{job_id}/result GET Obtener el resultado de la conversi贸n
/convert/{job_id}/images GET Listar im谩genes extra铆das
/convert/{job_id}/images/{id} GET Descargar una imagen extra铆da
/convert/{job_id}/tables GET Listar tablas extra铆das
/convert/{job_id}/tables/{id}/csv GET Descargar tabla como CSV
/convert/{job_id}/chunks GET Obtener fragmentos del documento
/export/{job_id}/{format} GET Descargar el archivo convertido

Endpoints de configuraci贸n

Endpoint M茅todo Descripci贸n
/settings GET/PUT Obtener/actualizar todos los ajustes
/settings/reset POST Restablecer valores predeterminados
/settings/formats GET Listar formatos admitidos
/settings/ocr GET/PUT Ajustes de OCR
/settings/tables GET/PUT Ajustes de tablas
/settings/images GET/PUT Ajustes de im谩genes
/settings/performance GET/PUT Ajustes de rendimiento
/settings/chunking GET/PUT Ajustes de fragmentaci贸n (chunks)

Endpoints de historial

Endpoint M茅todo Descripci贸n
/history GET Listar historial de conversiones
/history/{job_id} GET Obtener una entrada del historial
/history/stats GET Obtener estad铆sticas de conversi贸n
/history/search GET Buscar en el historial

Comprobaci贸n de estado (Health Check)

GET /health

Respuesta

{
  "status": "healthy",
  "service": "duckling-backend"
}

Respuestas de error

Todos los endpoints pueden devolver errores con el siguiente formato:

{
  "error": "Error type",
  "message": "Detailed error message"
}

C贸digos de estado HTTP

C贸digo Descripci贸n
200 脡xito
202 Aceptado (operaci贸n as铆ncrona iniciada)
400 Solicitud incorrecta (entrada no v谩lida)
404 No encontrado
413 Carga 煤til demasiado grande
500 Error interno del servidor

Limitaci贸n de velocidad

No hay limitaci贸n de velocidad implementada por el momento. En producci贸n, considere a帽adir un middleware de limitaci贸n.

CORS

La API permite solicitudes entre or铆genes desde el origen del frontend configurado (predeterminado: http://localhost:3000).