Source: https://ailoot.ai/docs/sk/cabinet/keys/ Canonical: https://ailoot.ai/docs/sk/cabinet/keys/ Language: sk [API používateľského účtu](https://ailoot.ai/docs/sk/) # API kľúče [Markdown](https://ailoot.ai/docs/sk/cabinet/keys/index.md) Metódy, polia požiadaviek a odpovede. Sekcia obsahuje 5 metód. Otvorte metódu a pozrite si podmienky prístupu, polia požiadavky a odpoveď. | Metóda a cesta | Opis | Prístup | | --- | --- | --- | | `GET /api/v1/keys` | Zoznam – API kľúče | Token používateľského účtu | | `POST /api/v1/keys` | Vytvorenie API kľúča | Token používateľského účtu | | `DELETE /api/v1/keys/:id` | Odstránenie – API kľúče | Token používateľského účtu | | `GET /api/v1/keys/:id` | Načítanie podľa identifikátora – API kľúče | Token používateľského účtu | | `PUT /api/v1/keys/:id` | Úprava API kľúča | Token používateľského účtu | **GET /api/v1/keys** – Zoznam – API kľúče Prístup: token používateľského účtu GET`/api/v1/keys` Čítanie; ID sa preberá z vašej predchádzajúcej odpovede ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys" \ -H "Authorization: Bearer $TOKEN" ``` ## Parametre query | Pole | Typ | Povinné | Kontrola / opis | | --- | --- | --- | --- | | `sort_by` | `string` | nie | ; predvolene: created\_at | | `sort_order` | `string` | nie | ; predvolene: desc | | `search` | `string` | nie | | | `status` | `string` | nie | | | `page` | `integer` | nie | ; predvolene: 1; positive; page\_size/limit \<=1000 | | `page_size` | `integer` | nie | ; predvolene: 20; positive; page\_size/limit \<=1000 | | `limit` | `integer` | nie | ; predvolene: 20; positive; page\_size/limit \<=1000 | Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL. ## Odpoveď Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie. Dátové schémy odpovede: `APIKey`. Polia a typy nájdete na stránkach „Dátové schémy“. Schéma odpovede, ilustračné hodnoty ```json { "code": 0, "message": "success", "data": { "items": [ { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } ], "total": "PLACEHOLDER_TOTAL (integer)", "page": "PLACEHOLDER_PAGE (integer)", "page_size": "PLACEHOLDER_PAGE_SIZE (integer)", "pages": "PLACEHOLDER_PAGES (integer)" } } ``` Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT. Osobitosti: odpoveď obsahuje tajný key; skutočné hodnoty nezverejňujte. **POST /api/v1/keys** – Vytvorenie API kľúča Prístup: token používateľského účtu POST`/api/v1/keys` ## Polia JSON / formulára | Pole | Typ | Povinné | Kontrola / opis | | --- | --- | --- | --- | | `name` | `string` | áno | required | | `custom_key` | `string` | nie | ; Voliteľná vlastná hodnota kľúča; môže byť null | | `ip_whitelist` | `array` | nie | ; Zoznam povolených IP | | `ip_blacklist` | `array` | nie | ; Zoznam zakázaných IP | | `quota` | `number` | nie | ; Limit výdavkov kľúča v USD; môže byť null | | `expires_in_days` | `integer` | nie | ; Platnosť v dňoch; môže byť null | | `rate_limit_5h` | `number` | nie | ; môže byť null | | `rate_limit_1d` | `number` | nie | ; môže byť null | | `rate_limit_7d` | `number` | nie | ; môže byť null | Šablóna tela požiadavky ```json { "name": "PLACEHOLDER_NAME (string)", "custom_key": "PLACEHOLDER_CUSTOM_KEY (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "quota": "PLACEHOLDER_QUOTA (number)", "expires_in_days": "PLACEHOLDER_EXPIRES_IN_DAYS (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)" } ``` PLACEHOLDER označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechajte iba potrebné voliteľné polia; reťazcové zástupné hodnoty sa neodosielajú namiesto čísel, hodnôt boolean, objektov alebo polí. Schéma požiadavky: `CreateAPIKeyRequest` ## Odpoveď Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie. Dátové schémy odpovede: `APIKey`. Polia a typy nájdete na stránkach „Dátové schémy“. Schéma odpovede, ilustračné hodnoty ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } } ``` Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT. Osobitosti: operácia mení stav alebo pokračuje v jednorazovej autorizácii; príklad opisuje kontrakt a nevykonáva sa. Osobitosti: Idempotency-Key je podporovaný; opakovanie vracia uloženú odpoveď s X-Idempotency-Replayed. Osobitosti: odpoveď obsahuje tajný key; skutočné hodnoty nezverejňujte. Metóda mení údaje. Opätovné odoslanie je bezpečné iba vtedy, ak je pri metóde uvedený Idempotency-Key. Ak sa odpoveď stratila, najprv overte výsledok (napríklad zoznam kľúčov) a až potom sa rozhodnite, či požiadavku zopakovať. **DELETE /api/v1/keys/:id** – Odstránenie – API kľúče Prístup: token používateľského účtu DELETE`/api/v1/keys/:id` ## Parametre cesty | Pole | Typ | Povinné | Kontrola / opis | | --- | --- | --- | --- | | `id` | `integer` | áno | | Telo požiadavky sa nevyžaduje. ## Odpoveď Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie. Schéma odpovede, ilustračné hodnoty ```json { "code": 0, "message": "success", "data": { "message": "VALUE_FROM_RESPONSE" } } ``` Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT. Osobitosti: operácia mení stav alebo pokračuje v jednorazovej autorizácii; príklad opisuje kontrakt a nevykonáva sa. Osobitosti: odpoveď obsahuje tajný key; skutočné hodnoty nezverejňujte. Metóda mení údaje. Opätovné odoslanie je bezpečné iba vtedy, ak je pri metóde uvedený Idempotency-Key. Ak sa odpoveď stratila, najprv overte výsledok (napríklad zoznam kľúčov) a až potom sa rozhodnite, či požiadavku zopakovať. **GET /api/v1/keys/:id** – Načítanie podľa identifikátora – API kľúče Prístup: token používateľského účtu GET`/api/v1/keys/:id` Čítanie; ID sa preberá z vašej predchádzajúcej odpovede ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys/$ID" \ -H "Authorization: Bearer $TOKEN" ``` ## Parametre cesty | Pole | Typ | Povinné | Kontrola / opis | | --- | --- | --- | --- | | `id` | `integer` | áno | | Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL. ## Odpoveď Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie. Dátové schémy odpovede: `APIKey`. Polia a typy nájdete na stránkach „Dátové schémy“. Schéma odpovede, ilustračné hodnoty ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } } ``` Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT. Osobitosti: odpoveď obsahuje tajný key; skutočné hodnoty nezverejňujte. **PUT /api/v1/keys/:id** – Úprava API kľúča Prístup: token používateľského účtu PUT`/api/v1/keys/:id` ## Parametre cesty | Pole | Typ | Povinné | Kontrola / opis | | --- | --- | --- | --- | | `id` | `integer` | áno | | ## Polia JSON / formulára | Pole | Typ | Povinné | Kontrola / opis | | --- | --- | --- | --- | | `name` | `string` | nie | | | `status` | `string` | nie | omitempty,oneof=active inactive | | `ip_whitelist` | `array` | nie | ; Povolené IP: null nemení zoznam, prázdne pole ho vymaže; môže byť null | | `ip_blacklist` | `array` | nie | ; Zakázané IP: null nemení zoznam, prázdne pole ho vymaže; môže byť null | | `quota` | `number` | nie | ; Limit výdavkov kľúča v USD; 0 znamená bez limitu; môže byť null | | `expires_at` | `string` | nie | ; Čas skončenia platnosti vo formáte ISO 8601; môže byť null | | `reset_quota` | `boolean` | nie | ; Vynulovať vyčerpanú časť limitu výdavkov; môže byť null | | `rate_limit_5h` | `number` | nie | ; môže byť null | | `rate_limit_1d` | `number` | nie | ; môže byť null | | `rate_limit_7d` | `number` | nie | ; môže byť null | | `reset_rate_limit_usage` | `boolean` | nie | ; Vynulovať spotrebu limitov za časové okná; môže byť null | Šablóna tela požiadavky ```json { "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "quota": "PLACEHOLDER_QUOTA (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "reset_quota": "PLACEHOLDER_RESET_QUOTA (boolean)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "reset_rate_limit_usage": "PLACEHOLDER_RESET_RATE_LIMIT_USAGE (boolean)" } ``` PLACEHOLDER označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechajte iba potrebné voliteľné polia; reťazcové zástupné hodnoty sa neodosielajú namiesto čísel, hodnôt boolean, objektov alebo polí. Schéma požiadavky: `UpdateAPIKeyRequest` ## Odpoveď Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie. Dátové schémy odpovede: `APIKey`. Polia a typy nájdete na stránkach „Dátové schémy“. Schéma odpovede, ilustračné hodnoty ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } } ``` Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT. Osobitosti: operácia mení stav alebo pokračuje v jednorazovej autorizácii; príklad opisuje kontrakt a nevykonáva sa. Osobitosti: odpoveď obsahuje tajný key; skutočné hodnoty nezverejňujte. Osobitosti: kým má kľúč nedokončené požiadavky s rezerváciou, jeho limit výdavkov nemožno znížiť ani vynulovať. Odovzdávajte iba polia, ktoré meníte. Metóda mení údaje. Opätovné odoslanie je bezpečné iba vtedy, ak je pri metóde uvedený Idempotency-Key. Ak sa odpoveď stratila, najprv overte výsledok (napríklad zoznam kľúčov) a až potom sa rozhodnite, či požiadavku zopakovať. Máte ďalšie otázky? Pošlite Request ID a opis problému – pomôžeme vám ho vyriešiť.[Napísať podpore](mailto:support@ailoot.ai) ## Ailoot · Spoločnosť a jej portfólio projektov Ailoot stavia na dlhodobých prevádzkových skúsenostiach, širokej klientskej základni, stabilných službách a priebežnom sledovaní KPI. Spoločnosť a jej portfólio projektov: milióny zákazníkov; mesačné tržby v miliardách. Ailoot využíva tieto prevádzkové skúsenosti na poskytovanie prístupu cez API k funkciám AI v produktoch zákazníkov, agentoch, aplikáciách a automatizáciách.