Salta ai contenuti

Avvio rapido

Il flusso seguente utilizza una chiave API per caricare un file, creare un lavoro di traduzione e scaricare i risultati.

  1. Prepara le credenziali e il file

    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. Richiedi un indirizzo e carica il file

    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. Conferma il caricamento e ottieni l’ID del 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. Crea il lavoro di traduzione

    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. Attendere il completamento e il 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)

Lo script stampa innanzitutto job_id. Quando l’operazione ha esito positivo, i risultati vengono scaricati nella directory corrente. Il polling si interrompe quando l’operazione raggiunge completed o failed.

Il tempo necessario dipende dalle dimensioni del file e dalla coda. In produzione, utilizzare un webhook o SSE invece del polling senza limiti.

L’esempio non riprova automaticamente le richieste di creazione. Dopo un timeout di rete, conserva l’ID del job, la chiave di idempotenza e il corpo della richiesta, e verifica prima lo stato. Un job già creato non viene annullato all’uscita dello script.

  • 401: verificare che la variabile d’ambiente sia impostata e che la chiave sia valida.
  • 402, oppure quota_exceeded in fase di lavoro: verificare che il saldo creditore (al netto dei debiti) copra la soglia di avvio.
  • 403: verificare il budget della chiave, le impostazioni consentite e il proprietario della risorsa.
  • 429: leggere il codice di errore commerciale per distinguere tra limite di frequenza, coda piena e budget esaurito.
  • L’indirizzo di caricamento diretto è scaduto o il caricamento non è riuscito: richiedi un nuovo indirizzo di caricamento.

Registra il X-Request-Id e il percorso della richiesta, ma mai la chiave completa o le credenziali di caricamento. Tutti gli errori e i metodi di retry sono riportati nel riferimento agli errori.