Saltearse al contenido

Herramientas para documentos y archivos

OmniDoc ofrece herramientas de archivos sincrónicas y operaciones de documentos asíncronas rastreables. Llame primero a los puntos finales de la funcionalidad; no codifique de forma rígida los formatos o límites admitidos en el cliente.

GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

Estos devuelven las operaciones actualmente abiertas, sus formatos de entrada, límites de facturación y límites técnicos. Las capacidades enumeradas bajo unavailable no pueden crearse.

POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

Este punto final requiere un Idempotency-Key. kind incluye actualmente:

  • extract: extracción estructurada, gratuita.
  • pdf_to_html: PDF a en línea HTML, gratis.
  • visual_extract: extracción estructurada visual, tarificación por página (1 crédito por página). Antes de comenzar, el número máximo de páginas que puede procesar se establece en función del saldo disponible (como máximo 20 páginas); si el saldo cubre menos de 1 página, devuelve 402. Al finalizar, se facturan las páginas efectivamente procesadas y el saldo puede quedar negativo.

Consultar y cancelar:

GET /api/v1/document-operations/{operation_id}
GET /api/v1/document-operations?limit=25
POST /api/v1/document-operations/{operation_id}/cancel

Cuando finaliza, el output_document_id de la respuesta puede almacenarse en la biblioteca de archivos o enviarse a otro trabajo, y credit_operation_id proporciona el registro de liquidación.

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

Ejemplo de fusión:

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

Ejemplo de división:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

Las herramientas solo aceptan documentos que pertenecen a la cuenta actual y cuyo tipo coincida. Transmita las respuestas binarias y obtenga el nombre y el tipo de archivo de los encabezados de la respuesta.