Pular para o conteúdo

Início rápido

O fluxo abaixo utiliza uma chave de API para carregar um arquivo, criar uma tarefa de tradução e baixar os resultados.

  1. Prepare as credenciais e o arquivo

    Terminal window
    export OMNIDOC_API_KEY="sk_your_key"
    BASE="https://omnidoc.top/api/v1"
    FILE="report.docx"
    SIZE=$(wc -c < "$FILE" | tr -d ' ')
  2. Solicitar um endereço e carregar o arquivo

    Terminal window
    PRESIGN=$(curl --fail-with-body -sS "$BASE/upload/presign" \
    -H "X-API-Key: $OMNIDOC_API_KEY" \
    -H "Content-Type: application/json" \
    -d "$(jq -n --arg filename "$(basename "$FILE")" --argjson size "$SIZE" \
    '{filename:$filename,file_size:$size}')")
    UPLOAD_URL=$(printf '%s' "$PRESIGN" | jq -r '.upload_url')
    UPLOAD_TYPE=$(printf '%s' "$PRESIGN" | jq -r '.upload_headers["Content-Type"]')
    FINALIZE_TOKEN=$(printf '%s' "$PRESIGN" | jq -r '.finalize_token')
    curl --fail-with-body -sS -X PUT "$UPLOAD_URL" \
    -H "Content-Type: $UPLOAD_TYPE" \
    -H "If-None-Match: *" \
    --upload-file "$FILE"
  3. Confirme o carregamento e obtenha o ID do documento

    Terminal window
    DOCUMENT=$(curl --fail-with-body -sS "$BASE/upload/finalize" \
    -H "X-API-Key: $OMNIDOC_API_KEY" \
    -H "Content-Type: application/json" \
    -d "$(jq -n --arg token "$FINALIZE_TOKEN" '{finalize_token:$token}')")
    DOCUMENT_ID=$(printf '%s' "$DOCUMENT" | jq -r '.document.id')
  4. Criar o trabalho de tradução

    Terminal window
    JOB=$(curl --fail-with-body -sS "$BASE/jobs" \
    -H "X-API-Key: $OMNIDOC_API_KEY" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: $(uuidgen)" \
    -d "$(jq -n --arg document_id "$DOCUMENT_ID" \
    '{document_id:$document_id,target_lang:"en"}')")
    JOB_ID=$(printf '%s' "$JOB" | jq -r '.id')
  5. Aguardar conclusão e download

    import re
    import time
    from urllib.parse import unquote
    while True:
    response = requests.get(f"{BASE}/jobs/{job_id}", headers=H, timeout=20)
    response.raise_for_status()
    job = response.json()
    if job["status"] in {"completed", "failed"}:
    break
    time.sleep(3)
    if job["status"] == "failed":
    raise RuntimeError(job.get("error_msg") or "translation failed")
    artifacts = requests.get(
    f"{BASE}/artifacts", headers=H, params={"job_id": job_id}, timeout=20
    )
    artifacts.raise_for_status()
    for artifact in artifacts.json():
    download = requests.get(
    f"{BASE}/artifacts/{artifact['id']}/download",
    headers=H,
    timeout=300,
    )
    download.raise_for_status()
    fallback = f"{artifact['id']}.{artifact['format']}"
    disposition = download.headers.get("Content-Disposition", "")
    utf8 = re.search(r"filename\*=UTF-8''([^;]+)", disposition, re.I)
    plain = re.search(r'filename="([^"]+)"', disposition, re.I)
    if utf8:
    name = unquote(utf8.group(1))
    elif plain:
    name = plain.group(1)
    else:
    name = fallback
    safe_name = Path(name).name or fallback
    Path(safe_name).write_bytes(download.content)

O script primeiro exibe o job_id. Quando a tarefa é concluída com sucesso, os resultados são baixados para o diretório atual. A verificação é interrompida quando a tarefa atinge completed ou failed.

O tempo necessário depende do tamanho do arquivo e da fila. Em produção, use um webhook ou SSE em vez de polling sem limite.

O exemplo não tenta novamente as solicitações de criação automaticamente. Após um timeout de rede, mantenha o ID do job, a chave de idempotência e o corpo da solicitação, verificando o status primeiro. Um job que foi criado não é cancelado quando o script é encerrado.

  • 401: verifique se a variável de ambiente está definida e se a chave é válida.
  • 402, ou quota_exceeded no trabalho: verifique se o saldo credor (após débitos) cobre o limiar de início.
  • 403: verifique o orçamento da chave, as configurações permitidas e quem é o proprietário do recurso.
  • 429: leia o código de erro comercial para diferenciar limite de taxa, fila cheia e orçamento esgotado.
  • O endereço de upload direto expirou ou o upload falhou: solicite um novo endereço de upload.

Registre o X-Request-Id e o caminho da solicitação, mas nunca a chave completa ou as credenciais de upload. Todos os erros e métodos de retentativa estão na referência de erro . .