Pular para o conteúdo

Ferramentas de documentos e arquivos

OmniDoc oferece ferramentas de arquivos síncronos e operações de documentos assíncronas rastreáveis. Chame primeiro os endpoints de capacidade; não codifique formatos ou limites suportados diretamente no cliente.

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

Esses retornam as operações atualmente abertas, seus formatos de entrada, limites de cobrança e técnicos. Capacidades listadas sob unavailable não podem ser criadas.

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

Este endpoint requer um Idempotency-Key. kind atualmente inclui:

  • extract: extração estruturada, gratuita.
  • pdf_to_html: PDF para online HTML, gratuito.
  • visual_extract: extração estruturada visual, cobrada por página (1 crédito por página). Antes de iniciar, o número máximo de páginas que pode processar é definido com base no saldo (no máximo 20 páginas); se o saldo cobrir menos de 1 página, retorna 402. Ao finalizar, são cobradas as páginas efetivamente processadas, podendo o saldo ficar negativo.

Consultar e cancelar:

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

Ao concluir, o output_document_id da resposta pode ser armazenado na biblioteca de arquivos ou em outro job, e credit_operation_id fornece o registro de liquidação.

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

Exemplo de mesclagem:

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

Exemplo de divisão:

{"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
}

As ferramentas aceitam apenas documentos de propriedade da conta atual e cujo tipo seja compatível. Transfira respostas binárias em fluxo e obtenha o nome e o tipo do arquivo dos cabeçalhos da resposta.