API-Übersicht
Base URL
https://omnidoc.top/api/v1Senden Sie Content-Type: application/json mit JSON-Anfragen. Der API-Schlüssel ist im X-API-Key-Header oder als Bearer-Anmeldeinformation anzugeben.
Dienste
Abschnitt betitelt „Dienste“| Service | Hauptpfade | Zweck |
|---|---|---|
| Dateiupload | /upload/* | Dokumente hochladen und bestätigen |
| Dateibibliothek | /storage/files/*, /documents/* | Auflisten, lesen und herunterladen |
| Übersetzung | /jobs/*, /artifacts/* | Jobs erstellen, Status und Ergebnisse prüfen |
| Dokumentwerkzeuge | /document-operations/*, /file-tools/* | Konvertieren, Zusammenführen, Aufteilen, Komprimieren und mehr |
| Sofortige Übersetzung | /ai/* | Kurztext- und Batch-Segmentübersetzung |
| Audio und Video | /media-jobs/*, /media-voices/* | Jobs und Stimmen |
| Glossare | /glossaries/* | Begriffe, Import und Export |
| Verwendung und Urheberrechte | /usage/*, /billing/credits/* | Nutzungs-, Salden- und Abrechnungsdatensätze |
| Benachrichtigungen | /sse/*, /webhooks/* | Echtzeitfortschritt und Rückrufe |
Welche Dienste Sie aufrufen können und wie viel sie kosten: Dienste und Berechtigungen .
Konventionen
Abschnitt betitelt „Konventionen“- Ressourcen-IDs sind undurchsichtige Zeichenketten.
- Senden Sie einen
Idempotency-Keymit Erstellungsanfragen; Dokumentenoperationen, Medienjobs und Spracherstellung erfordern jeweils einen solchen. - Die Parameter für die Seitennavigation werden auf der jeweiligen Endpunkt-Seite beschrieben.
- Handle
429wie beschrieben in errors and retries . - Die heruntergeladenen Dateinamen dienen nur der Anzeige; verwenden Sie den Basisnamen und beachten Sie die Einschränkungen Ihres Dateisystems, bevor Sie die Datei speichern.
Anforderungstracing
Abschnitt betitelt „Anforderungstracing“Behalten Sie den X-Request-Id jedes Antwortobjekts bei. Wenn Sie den Support kontaktieren, geben Sie diesen Wert, die Anfragezeit und den Pfad an; senden Sie niemals den vollständigen API-Schlüssel oder den Inhalt der Datei.