Met ’n API-sleutel staafwerk verifieer

Hierdie bladsy handel oor hoe om met ’n API-sleutel by die CLEVI-gateway te staafwerk.
Beide die OpenAI-versoenbare roete en die Anthropic-versoenbare roete word met een sleutel geverifieer,
maar die toegelate kopskrif vir die sleutel en die basis-URL wat in die SDK gestel moet word, verskil volgens die spesifikasie.

Staafwerkkopskrif

Beide versoenbare spesifikasies word met een API-sleutel geverifieer. Die sleutel word op die API-sleutel-skerm in die konsole uitgereik, en herroeping en gebruiksbereik word op dieselfde skerm bestuur.

Kopskrifname is nie hooflettergevoelig nie. x-api-key wat deur die Anthropic SDK gestuur word, werk ook onveranderd.

basis-URL

Die SDK wat jy gebruik het, werk onveranderd as jy net die basis-URL na die onderstaande adres verander. Die twee adresse verskil daarin of /v1 ingesluit word.

Verifiëring van staafwerk

Jy kan onmiddellik vasstel of staafwerk geverifieer is deur die sleutel en basis-URL in te vul en die modell lys op te vra. Die drie voorbeelde hieronder voer dieselfde navraag met curl, OpenAI SDK en Anthropic SDK uit.

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)

Plaas die sleutel wat op die API-sleutel-skerm uitgereik is in die plek van sk-....

• As die antwoord 200 is, is staafwerk geverifieer. data bevat die lys modelle wat met hierdie sleutel aangeroep kan word.
• As die antwoord 401 is, volg die volgorde in die afdeling oor staafwerkfaling hieronder om dit na te gaan.

Kopskrifte wat saam gebruik word

Alles is opsioneel. Om probleme op te spoor, is dit raadsaam om X-Request-Id in te sluit.

Verifikasiemislukking

As jy geen sleutel of ’n sleutel wat verval of herroep is, stuur, is die antwoord 401. Wanneer jy ’n OpenAI-versoenbare roete sonder ’n sleutel oproep, word die onderstaande liggaam teruggestuur, en error.type in ’n Anthropic-versoenbare roete is authentication_error.

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

1. Gaan die sleutelstatus op die API-sleutelskerm na. As die sleutel verval of herroep is, reik ’n nuwe een uit.
2. Bevestig of die opskrifnaam X-API-Key of Authorization is.
3. As jy Authorization in ’n OpenAI-versoenbare roete gebruik, bevestig die Bearer-voorvoegsel.