Przejdź do głównej zawartości

Szybki start

Poniższy przepływ wykorzystuje klucz API do przesyłania jednego pliku, tworzenia zadania tłumaczeniowego i pobierania wyników.

  1. Przygotuj dane uwierzytelniające i plik

    Okno terminala
    export OMNIDOC_API_KEY="sk_your_key"
    BASE="https://omnidoc.top/api/v1"
    FILE="report.docx"
    SIZE=$(wc -c < "$FILE" | tr -d ' ')
  2. Poproś o adres i przekaż plik

    Okno terminala
    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. Potwierdź przesyłanie i uzyskaj identyfikator dokumentu

    Okno terminala
    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. Utwórz zadanie tłumaczeniowe

    Okno terminala
    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. Poczekaj na zakończenie i pobierz

    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)

Skrypt najpierw wyświetla job_id. Gdy zadanie zakończy się powodzeniem, wyniki są pobierane do bieżącego katalogu. Opolowanie zostaje zakończone, gdy zadanie osiągnie completed lub failed.

Czas trwania zależy od rozmiaru pliku i kolejki. W środowisku produkcyjnym zamiast nieograniczonego pobierania danych używaj webhook lub SSE .

Przykład nie podejmuje automatycznie kolejnych prób utworzenia żądań. Po przekroczeniu limitu czasu połączenia należy zachować identyfikator zadania, klucz idempotencji oraz treść żądania i najpierw sprawdzić status. Zadanie, które zostało utworzone, nie jest anulowane po zakończeniu skryptu.

  • 401: sprawdź, czy zmienna środowiskowa jest ustawiona i klucz jest ważny.
  • 402, lub quota_exceeded podczas pracy: sprawdź, czy saldo kredytowe (po odjęciu zadłużenia) pokrywa próg startowy.
  • 403: sprawdź budżet klucza, jego dozwolone ustawienia oraz właściciela zasobu.
  • 429: odczytaj kod błędu biznesowego, aby rozróżnić limit przepustowości, pełną kolejkę i wyczerpane budżet.
  • Adres do bezpośredniego przesyłania wygasł lub przesyłanie nie powiodło się: poproś o nowy adres przesyłania.

Zapisuj X-Request-Id i ścieżkę żądania, ale nigdy pełnego klucza ani danych uwierzytelniających do przesyłania. Wszystkie błędy i metody powtórnego próbowania znajdują się w odniesieniu error reference .