Перейти к содержимому

Быстрый старт

В приведённом ниже примере используется ключ API для загрузки одного файла, создания задания на перевод и скачивания результатов.

  1. Подготовьте учетные данные и файл

    Окно терминала
    export OMNIDOC_API_KEY="sk_your_key"
    BASE="https://omnidoc.top/api/v1"
    FILE="report.docx"
    SIZE=$(wc -c < "$FILE" | tr -d ' ')
  2. Запросить адрес и загрузить файл

    Окно терминала
    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. Подтвердите загрузку и получите ID документа

    Окно терминала
    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. Создать задание на перевод

    Окно терминала
    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. Подождите завершения и загрузки

    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)

Скрипт сначала выводит job_id. При успешном выполнении задания результаты загружаются в текущий каталог. Опрос прекращается, когда задание достигает completed или failed.

Время выполнения зависит от размера файла и очереди. В продакшене используйте webhook или SSE вместо неограниченного опроса.

В данном примере автоматическая повторная отправка запросов на создание отсутствует. После сетевого тайм-аута сохраните идентификатор задания, ключ идемпотентности и тело запроса, а затем сначала проверьте статус. Созданное задание не отменяется при завершении выполнения скрипта.

  • 401: проверьте, что переменная окружения установлена и ключ действителен.
  • 402 или quota_exceeded в работе: проверьте, покрывает ли кредитный остаток (за вычетом задолженности) пороговый уровень запуска.
  • 403: проверьте бюджет ключа, допустимые настройки и владельца ресурса.
  • 429: считывает код бизнес-ошибки, позволяя различать ограничение скорости, переполненную очередь и исчерпание бюджета.
  • Срок действия адреса прямой загрузки истёк или загрузка не удалась: запросите новый адрес загрузки.

Логируйте X-Request-Id и путь запроса, но никогда не логируйте полный ключ или учетные данные загрузки. Все ошибки и методы повторной попытки указаны в ссылке на ошибку error reference .