Pular para o conteúdo

Carregar arquivos

O carregamento ocorre em três etapas: solicitar um endereço de upload, enviar o arquivo e confirmar o documento. Um endereço de upload pode ser gerado uma única vez e permanece válido por até 1 hora.

POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
CampoTipoObrigatórioDescrição
filenamestring✅Nome do arquivo; o servidor determina o tipo de arquivo pela extensão
file_sizeinteiro✅Tamanho exato em bytes, maior que 0
mime_typestring—Opcional; o servidor não o utiliza

Resposta:

{
"document_id": "4q8mx2q9z1k7p6ra",
"upload_url": "https://upload.example/...",
"upload_headers": {
"Content-Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"If-None-Match": "*"
},
"finalize_token": "short_lived_token",
"expires_in": 3600
}

Envie um PUT para upload_url com os bytes do arquivo bruto como corpo e envie cada cabeçalho em upload_headers exatamente conforme fornecido.

Terminal window
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous response
curl --fail-with-body -X PUT "$UPLOAD_URL" \
-H "Content-Type: $UPLOAD_CONTENT_TYPE" \
-H "If-None-Match: *" \
--upload-file "report.docx"

Não envie sua chave API OmniDoc nesta etapa. Se o endereço expirar ou a transferência falhar, solicite uma nova.

POST /api/v1/upload/finalize
X-API-Key: sk_your_key
Content-Type: application/json
{"finalize_token":"short_lived_token"}

Em caso de sucesso, o documento é retornado:

{
"document": {
"id": "4q8mx2q9z1k7p6ra",
"basename": "report.docx",
"file_size": 45678,
"mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"created_at": "2026-10-01T12:00:00Z"
}
}

Somente após a confirmação o documento entra na biblioteca de arquivos e passa a estar disponível para uso em trabalhos.

filename é apenas para exibição; não o utilize como um caminho ou identificador exclusivo. O servidor substitui caracteres ilegais e gera um nome de download seguro para nomes que sejam muito longos.

StatusCausa
400Nome ou tamanho do arquivo inválido, ou o tamanho enviado difere do solicitado
401Credencial ou finalize_token inválida ou expirada
403O finalize_token pertence a outra conta
410O arquivo carregado não foi encontrado (transferência incompleta ou endereço expirado); solicite um novo endereço
413Excede o limite de tamanho por arquivo
415Formato não suportado ou o conteúdo não corresponde à extensão
422O arquivo Office está danificado ou estruturalmente inseguro
429Uploads em excesso
503O serviço de envio está temporariamente indisponível; tente novamente mais tarde