Documentación API
API de Extracción de Información Clave
Extrae información estructurada de facturas, certificados y formularios usando esquema JSON personalizado, devuelve resultados en formato JSON
Resumen
La API de Extracción de Información Clave extrae información estructurada de facturas, certificados, formularios y otros documentos. Puede definir un esquema JSON personalizado para especificar qué campos extraer, y el modelo identificará inteligentemente y completará la información correspondiente de la imagen en formato JSON.
Utiliza un formato de solicitud JSON unificado, aceptando referencias URL o datos de imagen codificados en base64.
Autenticación
La API admite el siguiente método de autenticación:
- Clave API: Pase su clave API como parámetro de consulta
?key=SU_CLAVE_API
Extraer Información Estructurada de Imagen
Extrae información estructurada de archivos de imagen utilizando tecnología de reconocimiento inteligente con esquema JSON personalizado.
Solicitud
POST /api/key-information-extractionParámetros:
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| document | object | Sí | Objeto documento |
| document.type | string | Sí | Valor fijo "image_url" |
| document.image_url | string | Sí | URL de imagen o datos base64 |
| result_schema | object/string | Sí | Esquema JSON que define campos a extraer |
| filename | string | No | Nombre de archivo (recomendado para datos base64) |
| key | string | No | Clave API (parámetro de consulta, opcional para usuarios registrados) |
Notas sobre result_schema:
- Puede ser un objeto JSON o una cadena JSON
- Admite hasta 3 niveles de anidamiento
- Solo defina claves (nombres de campos), mantenga los valores como cadenas vacías
- Admite estructuras de array
Ejemplos:
Usando URL de Imagen:
curl -X POST "https://llmocr.com/api/key-information-extraction?key=SU_CLAVE_API" \
-H "Content-Type: application/json" \
-d '{
"document": {
"type": "image_url",
"image_url": "https://llmocr.com/invoice.jpg"
},
"result_schema": {
"Seller Name": "",
"Buyer Name": "",
"Price Excluding Tax": "",
"Invoice Code": ""
}
}'Usando Datos de Imagen Base64:
curl -X POST "https://llmocr.com/api/key-information-extraction?key=SU_CLAVE_API" \
-H "Content-Type: application/json" \
-d '{
"document": {
"type": "image_url",
"image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA..."
},
"result_schema": {
"Name": "",
"ID Number": "",
"Address": ""
},
"filename": "id-card.jpg"
}'Respuesta
Parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | string | ID de registro en la base de datos |
| filename | string | Nombre de archivo |
| content | string | Información estructurada extraída (formato de cadena JSON) |
| format | string | Formato de salida, fijo como "json" |
| timestamp | number | Marca de tiempo de finalización del procesamiento |
| payload | string | URL del endpoint API |
Ejemplo:
{
"id": "12345",
"filename": "invoice.jpg",
"content": "{\"Seller Name\":\"ABC Company Ltd\",\"Buyer Name\":\"John Doe\",\"Price Excluding Tax\":\"270000.00\",\"Invoice Code\":\"142011726001\"}",
"format": "json",
"timestamp": 1640995200000,
"payload": "https://llmocr.com/api/key-information-extraction?key=SU_CLAVE_API"
}