Przegląd API
Base URL
https://omnidoc.top/api/v1Wysyłaj żądania Content-Type: application/json z JSON. Klucz API należy umieścić w nagłówku X-API-Key lub jako poświadczenia Bearer.
| Usługa | Główne ścieżki | Cel |
|---|---|---|
| Przesyłanie pliku | /upload/* | Prześlij i potwierdź dokumenty |
| Biblioteka plików | /storage/files/*, /documents/* | Lista, odczytaj i pobierz |
| $ x $ | /jobs/*, /artifacts/* | Utwórz zadania, sprawdź status i wyniki |
| Narzędzia dokumentacyjne | /document-operations/*, /file-tools/* | Konwertuj, łącz, dziel, kompresuj i więcej |
| Natychmiastowy tłumaczenie | /ai/* | Krótki tekst i tłumaczenie segmentów partiami |
| Audio i wideo | /media-jobs/*, /media-voices/* | Prace i głosy |
| Słowniczki | /glossaries/* | Terminy, import i eksport |
| Użycie i podziękowania | /usage/*, /billing/credits/* | Rekordy użytkowania, salda i rozliczeń |
| Powiadomienia | /sse/*, /webhooks/* | Bieżący postęp i funkcje zwrotne |
Które usługi możesz wywołać i jakie są ich koszty: usługi i uprawnienia .
Konwencje
Dział zatytułowany „Konwencje”- Identyfikatory zasobów to nieprzejrzyste łańcuchy znaków.
- Wysyłaj
Idempotency-Keyz żądaniami tworzenia; operacje dokumentów, zadania multimedialne i tworzenie głosu wymagają jednego. - Parametry paginacji są opisane na stronie każdego punktu końcowego.
- Obsłuż
429zgodnie z opisem w błędy i powtórne próby . - Nazwy pobranych plików służą wyłącznie do wyświetlania; przed zapisaniem użyj nazwy bez ścieżki i dostosuj się do ograniczeń systemu plików.
Śledzenie żądań
Dział zatytułowany „Śledzenie żądań”Zachowaj X-Request-Id z każdej odpowiedzi. Podczas kontaktu z obsługą techniczną podaj to wartość, czas żądania oraz ścieżkę; nigdy nie przesyłaj pełnego klucza API ani zawartości pliku.