Developer guide
Autentizace pomocí klíče API
Hlavičky, do kterých se zadává klíč API, a base URL pro nastavení v SDK
Tato stránka popisuje, jak se autentizovat pomocí klíče API ke шлюзу CLEVI.
Pro cesty kompatibilní s OpenAI i Anthropic se používá jeden klíč,
ale povolené hlavičky obsahující klíč a base URL nastavená v SDK se podle specifikace liší.
Autentizační hlavičky
Obě kompatibilní specifikace používají k autentizaci jeden klíč API. Klíč vydáte na stránce klíčů API v konzoli a na stejné stránce můžete spravovat jeho zneplatnění a rozsah použití.
| Hlavička | Kompatibilní s OpenAI | Kompatibilní s Anthropic |
|---|---|---|
| X-API-Key: <klíč> | Povoleno | Povoleno |
| Authorization: Bearer <klíč> | Povoleno | Povoleno |
| Authorization: <klíč> (bez Bearer) | Odmítnuto | Povoleno |
Na velikosti písmen v názvu hlavičky nezáleží. Funguje i x-api-key, které odesílá Anthropic SDK.
base URL
Používané SDK bude fungovat bez dalších změn, pokud pouze změníte base URL na níže uvedenou adresu. Tyto dvě adresy se liší tím, zda obsahují /v1.
| Specifikace | base URL | Pravidla cesty |
|---|---|---|
| Kompatibilní s OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Base URL obsahuje až /v1. |
| Kompatibilní s Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK přidává /v1 do cesty samo, takže URL končí před /v1. |
Ověření autentizace
Zda autentizace proběhla, můžete okamžitě ověřit zadáním klíče a base URL a načtením seznamu modelů. Níže se stejný dotaz provádí pomocí curl, OpenAI SDK a Anthropic SDK.
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)Místo sk-... zadejte klíč vydaný na stránce klíčů API.
- Pokud je odpověď 200, autentizace proběhla úspěšně. V data je seznam modelů, které lze pomocí tohoto klíče volat.
- Pokud je odpověď 401, postupujte podle pořadí v části Neúspěšná autentizace níže.
Společně používané hlavičky
Všechny jsou volitelné. Pro sledování problémů je vhodné X-Request-Id uvádět.
| Hlavička | Účel | Pokud je vynechána |
|---|---|---|
| X-Request-Id | Identifikátor pro sledování požadavku. V odpovědi kompatibilní s Anthropic se vrací jako hlavička request-id. | Vydává server. |
| X-Region-Code | Region volání | global. |
| X-Product-Sku (lze použít také jako parametr product_sku v dotazu) | Přímo určuje Product SKU použité pro účtování. Hlavička má přednost před parametrem dotazu a používá se především v cestách pro audio a voice. | V cestách pro voice je povinný. V případě audio/speech a audio/transcriptions se Product vybírá pomocí model v těle požadavku. |
| anthropic-version / anthropic-beta | V cestách kompatibilních s Anthropic se předávají beze změny. | Verze je 2023-06-01. |
Selhání autentizace
Pokud odešlete neexistující, prošlý nebo zneplatněný klíč, vrátí se 401. Při volání cesty kompatibilní s OpenAI bez klíče se vrátí níže uvedené tělo a v cestě kompatibilní s Anthropic je error.type authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Na stránce s klíči API zkontrolujte stav klíče. Pokud je prošlý nebo zneplatněný, vygenerujte nový.
- Zkontrolujte, zda je název hlavičky X-API-Key nebo Authorization.
- Pokud v cestě kompatibilní s OpenAI používáte Authorization, zkontrolujte předponu Bearer.