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.
Descoberta de capacidades
Seção intitulada “Descoberta de capacidades”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesEsses 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.
Operações de documentos assíncronas
Seção intitulada “Operações de documentos assíncronas”POST /api/v1/document-operationsIdempotency-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, retorna402. 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=25POST /api/v1/document-operations/{operation_id}/cancelAo 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.
Ferramentas PDF
Seção intitulada “Ferramentas PDF”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressExemplo de mesclagem:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Exemplo de divisão:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Ferramentas de imagem
Seção intitulada “Ferramentas de imagem”POST /api/v1/file-tools/image/convertPOST /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.