billed_pages en la respuesta).
Request
Headers
| Header | Tipo | Requerido | Descripcion |
|---|---|---|---|
Authorization | string | Si | Bearer <api_key> |
Este endpoint usa
multipart/form-data. No establezcas Content-Type manualmente — la mayoria de los clientes HTTP lo configuran automaticamente con el boundary correcto al enviar formularios.Query parameters
Codigo de pais. Valores permitidos:
COL, MEX, USA, ARG, WORLD.Si es
true, el campo json_response dentro de json_data se trata como un JSON Schema Draft 7 valido. Si es false, el sistema infiere las descripciones automaticamente.Flag interno adicional.
Body parameters (multipart/form-data)
String JSON con el esquema de extraccion. Debe contener tres campos:
document_type— Tipo de documento (ej."invoice","packing_list")document_description— Descripcion de lo que se quiere extraerjson_response— JSON Schema (Draft 7) que define la estructura de salida
El archivo a procesar. Formatos soportados: PDF, JPEG, PNG, TIFF, BMP, WEBP.Debe proporcionarse
file_path o file_url, no ambos.URL del documento a procesar. Alternativa a subir el archivo directamente.Debe proporcionarse
file_path o file_url, no ambos.Estructura del campo json_data
El parametro json_data es un string JSON con la siguiente estructura:
json_response se valida contra la especificacion JSON Schema Draft 7. No puede estar vacio.
Ejemplo de request
El siguiente ejemplo extrae datos de una factura comercial:Ejemplo con URL de archivo
Si el archivo ya esta alojado en un servidor, puedes usarfile_url en lugar de subir el archivo:
Response
Campos de respuesta
Estado de la extraccion. Valores posibles:
"success" o "error".Objeto con los datos extraidos del documento, estructurado segun el JSON Schema proporcionado en
json_data.json_response. Los campos coinciden con las propiedades definidas en tu schema.Numero de paginas del documento que fueron cobradas. Este valor determina el costo en creditos de la operacion.
Ejemplo de respuesta exitosa
Schemas para documentos comunes
Endpoints auxiliares
CamtomDocs tambien ofrece endpoints auxiliares que no consumen creditos:| Endpoint | Metodo | Descripcion |
|---|---|---|
/api/v3/camtomdocs/generate-schema | POST | Genera un JSON Schema a partir de una descripcion en texto |
/api/v3/camtomdocs/generate-excel-schema | POST | Genera un JSON Schema a partir de un archivo Excel |
/api/v3/camtomdocs/validate-schema | POST | Valida un JSON Schema contra la especificacion Draft 7 |
/api/v3/camtomdocs/validate-file | POST | Valida un archivo y devuelve metadatos (tipo, paginas, tamano) |
Errores comunes
| Codigo | Causa | Solucion |
|---|---|---|
400 | Campo json_data ausente o json_response vacio | Verifica que json_data contenga un JSON valido con document_type, document_description y json_response |
401 | API key invalida o ausente | Revisa el header Authorization |
402 | Creditos insuficientes | Recarga creditos en app.camtomx.com |
422 | JSON Schema invalido o formato de archivo no soportado | Valida tu schema con /api/v3/camtomdocs/validate-schema antes de enviar |
429 | Limite de cuota excedido | Espera antes de reintentar |
502 | Error en el procesamiento de IA | Reintenta la peticion. Si persiste, contacta soporte |