Autentizace pomocí klíče API

Brána CLEVI autentizuje kompatibilní cestu OpenAI a kompatibilní cestu Anthropic pomocí jediného klíče API.
Hodnoty, které je třeba nastavit na straně klienta, jsou dvě: autentizační hlavička obsahující klíč a base URL v SDK. Povolený formát hlavičky a base URL se liší podle specifikace.
Po dokončení nastavení můžete okamžitě ověřit, zda autentizace funguje, načtením seznamu modelů.
Při selhání autentizace se vrací 401. Pokud po úspěšné autentizaci nejsou splněny podmínky oprávnění nebo limitů, vrací se 403.

Klíč API si vygenerujte na obrazovce API klíčů v konzoli. Na stejné obrazovce můžete spravovat zneplatnění klíče a rozsah jeho použití.

Autentizační hlavička

Obě specifikace vkládají klíč API do jediné hlavičky požadavku. Používá se buď hlavička X-API-Key, nebo Authorization; povolený formát se liší podle specifikace.

Při použití hlavičky Authorization v kompatibilní cestě OpenAI je vyžadována předpona Bearer. Pokud odešlete pouze klíč bez předpony, brána požadavek odmítne.

Názvy hlaviček nerozlišují velká a malá písmena, takže bez úprav funguje i hlavička x-api-key odesílaná Anthropic SDK. Pokud zadáte obě hlavičky, přednost má hodnota X-API-Key.

base URL

Stávající SDK můžete nadále používat pouhou změnou base URL na níže uvedenou adresu. Tyto dvě adresy se liší tím, zda obsahují /v1, proto zadejte adresu odpovídající specifikaci přesně tak, jak je uvedena.

Ověření autentizace

Po nastavení klíče a základní adresy URL můžete ověřit, zda ověření proběhlo, načtením seznamu modelů. Níže uvedené příklady provádějí stejný dotaz pomocí curl, OpenAI SDK a Anthropic SDK. Na místo sk-... vložte klíč vydaný na obrazovce s klíčem API.

Při načítání pomocí curl zadejte úplnou cestu až po /v1/models pro oba standardy. První příkaz používá hlavičku X-API-Key pro cestu kompatibilní s OpenAI a druhý příkaz používá hlavičku Authorization pro cestu kompatibilní s Anthropic.

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"

V OpenAI SDK zadejte do base_url adresu včetně /v1.

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)

V Anthropic SDK zadejte do base_url adresu končící před /v1.
Pro ověření použijte beze změny hlavičku x-api-key, kterou SDK odesílá.

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)

Pokud je v kterémkoli příkladu odpověď 200, ověření proběhlo úspěšně a data v odpovědi obsahují seznam modelů, které lze pomocí tohoto klíče volat. Pokud obdržíte 401, zjistěte příčinu podle pořadí v následující části.

Neúspěšné ověření

Pokud odešlete neexistující, prošlý nebo zrušený klíč, bude vrácena odpověď 401. Při volání cesty kompatibilní s OpenAI bez klíče se vrátí níže uvedené tělo odpovědi, zatímco u cesty kompatibilní s Anthropic je error.type nastaveno na authentication_error.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

Pokud obdržíte 401, postupujte při kontrole v následujícím pořadí.

1. Na obrazovce s klíčem API zkontrolujte stav klíče. Pokud klíč prošel nebo byl zrušen, vydejte nový.
2. Zkontrolujte, zda je název hlavičky X-API-Key nebo Authorization.
3. Pokud na cestě kompatibilní s OpenAI používáte hlavičku Authorization, zkontrolujte, zda obsahuje předponu Bearer.

Po provedení oprav znovu spusťte načtení seznamu modelů v části Ověření a zkontrolujte, zda obdržíte odpověď 200.

Společně používané hlavičky

Všechny následující hlavičky jsou volitelné. Doporučujeme nastavit X-Request-Id, aby bylo možné problémy sledovat.

Pokud se opakovaně objevují chyby 5xx, informujte nás prostřednictvím nápovědy a kontaktního formuláře a uveďte X-Request-Id. Pokud jste hodnotu zadali přímo, lze ji okamžitě porovnat se záznamy klienta.