API nadzorne plošče
MarkdownMetode uporabniške nadzorne plošče: prijava, profil, ključi in zgodovina stroškov.
Celoten vodnik
Naslovi in avtentikacija
- Nadzorna plošča: https://ailoot.ai (prijava z uporabniškim imenom, žeton nadzorne plošče)
- API modelov: https://api.ailoot.ai (ključ sk-…)
| Kaj | Naslov | Avtentikacija |
|---|---|---|
| API nadzorne plošče | https://ailoot.ai/api/v1 | Authorization: Bearer $TOKEN – žeton nadzorne plošče po prijavi |
| API modelov | https://api.ailoot.ai/v1 | Ključ sk-… iz razdelka »Ključi API«; glejte Ključi in naslov API-ja |
Ključ sk-… ne nadomesti žetona nadzorne plošče, žeton nadzorne plošče pa ne omogoča dostopa do API-ja modelov. Celotna pot je navedena pri vsaki metodi.
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
-H "Authorization: Bearer $TOKEN"Format odgovora in napake
Odgovor vsebuje code, message in data. Napaka lahko vsebuje reason in metadata. Strani v data vsebujejo items, total, page, page_size in pages. Format posameznih metod je naveden v njihovem opisu.
{
"code": 0,
"message": "success",
"data": {
"items": [],
"total": 0,
"page": 1,
"page_size": 20,
"pages": 1
}
}Žeton nadzorne plošče se preveri glede na rok veljavnosti in aktivnost uporabnika; če je omogočena vezava seje, še glede na IP in brskalnik. Kode TOKEN_EXPIRED, TOKEN_REVOKED, USER_INACTIVE, INVALID_TOKEN in FORBIDDEN razlikujejo težave s sejo in pravicami. Omejitev pogostosti in dodatna potrditev 2FA lahko preprečita posamezno zahtevo.
Kako brati referenčno dokumentacijo
- Vsak zapis vsebuje metodo HTTP, celotno pot, dostop, parametre, polja telesa in odgovor.
- Identifikatorje vzemite iz prejšnjega odgovora: KEY_ID iz GET /api/v1/keys, ID zahteve iz GET /api/v1/usage.
- Polja objektov in njihove vrste so na straneh »Podatkovne sheme«.
- Predloge prikazujejo imena in vrste polj. PLACEHOLDER in TOKEN sta oznaki; pravih podatkov tukaj ni.
- Dodajanje sredstev je v razdelku »Cenik« nadzorne plošče: kako dodati sredstva.
Stanje in frozen_balance
Profil vsebuje balance in frozen_balance. frozen_balance je znesek, rezerviran za nedokončane zahteve. Obe polji preverite skupaj z zgodovino.
Ključi in omejitve
GET /api/v1/keys vrne vaše ključe. Polji quota in quota_used – omejitev porabe ključa in že porabljeni del; ip_whitelist, ip_blacklist, status in expires_at upravljajo uporabo ključa; rate_limit_5h, rate_limit_1d in rate_limit_7d – omejitve porabe v časovnih oknih.
curl --fail-with-body "https://ailoot.ai/api/v1/keys" \
-H "Authorization: Bearer $TOKEN"
# KEY_ID — id lastnega ključa iz odgovora s seznamom
curl --fail-with-body "https://ailoot.ai/api/v1/keys/$KEY_ID" \
-H "Authorization: Bearer $TOKEN"Stroški in varnost
Zgodovina in nadzorna plošča prikazujeta actual_cost – dejansko bremenitev; total_cost – strošek po standardni ceni. Filtri po datumu, modelu, ključu in vrsti zahteve so navedeni pri metodi. Sprememba gesla, TOTP in ključi za dostop zahtevajo potrditve, opisane pri ustreznih metodah.
V tem razdelku: 39 metod.