Zum Inhalt springen

Erstellen Sie einen Übersetzungsjob

POST /api/v1/jobs
Idempotency-Key: 7a40d1c7-6ee8-4cc1-b74b-132792bd402f
Content-Type: application/json
FeldTypErforderlichStandardBeschreibung
document_idZeichenfolge✅—ID eines bestätigten Dokuments
target_langZeichenfolge✅—Zielsprachcode
source_langZeichenfolge—Automatische ErkennungQuellcode
engineZeichenfolge—xr-397bÜbersetzungseinstellungs-ID, siehe Übersetzungseinstellungen
output_modeZeichenfolge—bilingualsingle oder bilingual
glossary_idZeichenfolge——Eine Glossar-ID dieses Kontos. Glossare sind für zahlende Konten vorgesehen (mindestens eine erfolgreiche Zahlung); ein unbezahltes Konto, das dennoch eine Zahlung sendet, erhält 403
include_imagesboolesch—falseÜbersetzen Sie außerdem den Text in den Bildern des Dokuments.
context_translationboolesch—falseKontextverbesserung aktivieren
style_presetZeichenfolge——Stilvoreinstellung

Ein erstellter Auftrag wird in die Warteschlange eingereiht. Jedes Konto verarbeitet gleichzeitig bis zu 5 Dateien; weitere Aufträge werden automatisch angelegt und in die Warteschlange eingereiht, sobald die vorherigen abgeschlossen sind. Während ein Auftrag wartet, gibt sein stage_message an, wie viele Aufträge noch vor ihm stehen.

Bevor ein Auftrag gestartet wird, wird das Guthaben mit einem Schwellenwert verglichen: Ein PDF benötigt ein Guthaben von mehr als „Seiten × 2 Credits“; andere Formate richten sich nach der Länge des Quelltextes, mindestens 2 Credits. Kann das Guthaben keine Datei starten, endet dieser Auftrag mit status=failed und quota_exceeded=true, es werden keine Kosten berechnet, und andere Aufträge sind nicht betroffen. Wenn ein Auftrag abgeschlossen ist, wird die tatsächliche Nutzung abgerechnet; übersteigen die Kosten das Guthaben, wird dieses negativ, eingehende Credits tilgen zuerst die Schulden, und neue Aufträge können bei negativem Guthaben nicht gestartet werden, daher muss aufgeladen werden. Siehe Credits und Nutzung .

Terminal-Fenster
curl --fail-with-body -X POST https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY" \
-H "Idempotency-Key: 7a40d1c7-6ee8-4cc1-b74b-132792bd402f" \
-H "Content-Type: application/json" \
-d '{"document_id":"4q8mx2q9z1k7p6ra","target_lang":"en"}'

Antwort 201 (der stage_message des Servers ist auf Chinesisch):

{
"id": "q3f8s6c2a9m1k4tx",
"document_id": "4q8mx2q9z1k7p6ra",
"source_lang": null,
"target_lang": "en",
"engine": "xr-397b",
"status": "pending",
"stage": "queued",
"stage_progress": 0,
"stage_message": "排队中",
"time_cost": 0,
"error_msg": null,
"quota_exceeded": false,
"queue_position": null,
"created_at": "2026-10-01T12:01:00Z",
"updated_at": "2026-10-01T12:01:00Z"
}
StatusUrsache
403Der Schlüssel erlaubt die gewählte Einstellung nicht, oder ein nicht bezahltes Konto hat glossary_id gesendet
404Das Dokument oder das Glossar existiert nicht, wurde gelöscht oder gehört einem anderen Konto.
415Das Dateiformat kann nicht übersetzt werden.
422Die Datei ist leer, enthält keinen übersetzten Text oder ein Parameter ist ungültig.
429Zu viele Anfragen oder die Warteschlange ist voll; bitte nach Retry-After erneut versuchen.

Idempotency-Key ist optional, wird jedoch für jede Einreichung empfohlen. Ein Schlüssel besteht aus 1–128 sichtbaren ASCII-Zeichen und bleibt für dieselben Anmeldeinformationen unbegrenzt gültig:

  • Gleicher Schlüssel, gleicher Körper: Gibt den ursprünglichen Auftrag zurück (einschließlich eines fehlgeschlagenen); nichts wird doppelt erstellt oder berechnet.
  • Gleicher Schlüssel, unterschiedlicher Körper: 409 (idempotency_request_conflict).
  • Der ursprüngliche Auftrag wurde gelöscht: 410 (idempotency_job_gone).

Verwenden Sie für jede neue Übermittlung einen neuen UUID und verwenden Sie den ursprünglichen Schlüssel nur beim erneuten Versuch derselben Übermittlung.