Przejdź do nawigacji
Obszar roboczyObszar roboczyDzienniki audytu

Utwórz klucz API

Utwórz nowy klucz API dla konta usługi

Parametry ścieżki

service_account_user_idstringWymagany

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
namestringWymagany
permissionslist of enums or "all"Wymagany
Uprawnienia XI API.
character_limitinteger or nullOpcjonalny

Limit znaków dla klucza XI API. Jeśli zostanie podany, ograniczy użycie tego klucza API do n znaków miesięcznie, gdzie n to wybrana wartość. Żądania generujące opłaty nie powiodą się po osiągnięciu tego miesięcznego limitu.

allowed_ipslist of strings or nullOpcjonalny

Lista adresów IP lub zakresów CIDR, które mogą używać tego klucza API. Każdy wpis może być zakresem CIDR (np. ‘10.0.0.0/24’) albo pojedynczym adresem IP (normalizowanym do /32 lub /128). Przy tworzeniu pomiń parametr lub przekaż null, aby zezwolić na wszystkie adresy IP. Przy aktualizacji pomiń go, aby nie zmieniać listy dozwolonych adresów, albo przekaż “clear”, aby ją usunąć.

third_party_disable_allowedboolean or nullOpcjonalny

Czy posiadacz tego klucza może go wyłączyć przez endpoint self-disable. Podczas tworzenia pomiń wartość lub przekaż null, aby użyć domyślnego ustawienia obszaru roboczego (włączonego w planach innych niż Enterprise, wyłączonego w planach Enterprise). Podczas aktualizacji pomiń wartość, aby pozostawić ją bez zmian, albo przekaż „clear”, aby przywrócić domyślne ustawienie obszaru roboczego. Opcja jest uwzględniana tylko dla obszarów roboczych z włączonym dostępem self-disable.

tts_concurrency_limitinteger or nullOpcjonalny

Maksymalna liczba równoczesnych żądań zamiany tekstu na mowę/mowa-mowa dla tego klucza API. Dostępne tylko dla klientów Enterprise.

dubbing_concurrency_limitinteger or nullOpcjonalny

Maksymalna liczba równoczesnych żądań dubbingu dla tego klucza API. Dostępne tylko dla klientów Enterprise.

music_concurrency_limitinteger or nullOpcjonalny

Maksymalna liczba równoczesnych żądań generowania muzyki dla tego klucza API. Dostępne tylko dla klientów Enterprise.

expires_at_unixinteger or nullOpcjonalny

Znacznik czasu Unix (w sekundach), po którym ten klucz API przestaje działać. Jeśli jest ustawiony, musi wskazywać czas od co najmniej 15 minut do maksymalnie 90 dni w przyszłości. Podczas tworzenia pomiń go lub przekaż null dla klucza, który nigdy nie wygasa. Podczas aktualizacji pomiń go, aby pozostawić bez zmian, albo przekaż “clear”, aby usunąć datę wygaśnięcia (klucz nigdy nie wygasa).

Odpowiedź

Pomyślna odpowiedź

xi-api-keystring
key_idstring

Błędy

422
Unprocessable Entity Error