Developer guide
Awtentikazzjoni b'ċavetta API
L-header li fih tiddaħħal iċ-ċavetta API u l-URL bażi li għandu jiġi kkonfigurat fl-SDK
Din il-paġna tispjega kif tawtentika lill-gateway ta' CLEVI b'ċavetta API.
Kemm ir-rotta kompatibbli ma' OpenAI kif ukoll dik kompatibbli ma' Anthropic jużaw ċavetta waħda għall-awtentikazzjoni,
iżda l-firxa permessa tal-header li fih tiddaħħal iċ-ċavetta u l-URL bażi li għandu jiġi kkonfigurat fl-SDK ivarjaw skont l-ispeċifikazzjoni.
Header tal-awtentikazzjoni
Iż-żewġ speċifikazzjonijiet kompatibbli jużaw ċavetta API waħda għall-awtentikazzjoni. Iċ-ċavetta tinħareġ mill-iskrin taċ-ċwievet API fil-console, u mill-istess skrin tista' timmaniġġja r-revoka u l-firxa tal-użu tagħha.
| Header | Kompatibbli ma' OpenAI | Kompatibbli ma' Anthropic |
|---|---|---|
| X-API-Key: <ċavetta> | Disponibbli għall-użu | Disponibbli għall-użu |
| Authorization: Bearer <ċavetta> | Disponibbli għall-użu | Disponibbli għall-użu |
| Authorization: <ċavetta> (mingħajr Bearer) | Miċħuda | Disponibbli għall-użu |
L-ismijiet tal-headers ma jagħmlux distinzjoni bejn ittri kbar u żgħar. x-api-key mibgħuta mill-Anthropic SDK taħdem ukoll kif inhi.
URL bażi
L-SDK li kont tuża jaħdem kif inhu jekk tibdel biss l-URL bażi għall-indirizz ta' hawn taħt. Iż-żewġ indirizzi jvarjaw jekk jinkludux /v1 jew le.
| Speċifikazzjoni | URL bażi | Regola tal-mogħdija |
|---|---|---|
| Kompatibbli ma' OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Inkludi sa /v1 fl-URL bażi. |
| Kompatibbli ma' Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | L-Anthropic SDK iżid /v1 mal-mogħdija waħdu, għalhekk jispiċċa qabel /v1. |
Verifika tal-awtentikazzjoni
Tista' tivverifika immedjatament jekk l-awtentikazzjoni rnexxietx billi ddaħħal iċ-ċavetta u l-URL bażi u tfittex il-lista tal-mudelli. It-tliet eżempji ta' hawn taħt jagħmlu l-istess tfittxija b'curl, OpenAI SDK u 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)Fil-post ta' sk-... daħħal iċ-ċavetta maħruġa mill-iskrin taċ-ċwievet API.
- Jekk ir-rispons ikun 200, l-awtentikazzjoni tkun saret. data jkun fiha l-lista tal-mudelli li jistgħu jintużaw biex isiru sejħiet b'din iċ-ċavetta.
- Jekk ir-rispons ikun 401, iċċekkja fl-ordni fit-taqsima dwar il-falliment tal-awtentikazzjoni hawn taħt.
Headers użati flimkien
Kollha huma fakultattivi. Biex issegwi l-problemi, huwa rakkomandat li żżid X-Request-Id.
| Header | Użu | Jekk jitħalla barra |
|---|---|---|
| X-Request-Id | Identifikatur għat-traċċar tat-talbiet. Fir-risposti kompatibbli ma’ Anthropic, jerġa’ jiġi bħala header request-id. | Jiġi assenjat mis-server. |
| X-Region-Code | Reġjun tas-sejħa | Huwa global. |
| X-Product-Sku (jista’ jintuża wkoll bħala product_sku fil-query) | Jispeċifika direttament il-Product SKU li għandu jintuża għall-kontijiet. Il-header għandu prijorità fuq il-query u jintuża prinċipalment fir-rotot tal-awdjo u tal-vuċi. | Huwa meħtieġ fir-rotot tal-vuċi. audio/speech u audio/transcriptions jagħżlu l-Product permezz tal-model fil-kontenut. |
| anthropic-version / anthropic-beta | Jiġi mgħoddi kif inhu fir-rotot kompatibbli ma’ Anthropic. | Il-verżjoni hija 2023-06-01. |
Falliment tal-awtentikazzjoni
Jekk tibgħat ċavetta nieqsa, skaduta jew revokata, tirċievi 401. Meta tagħmel sejħa mingħajr ċavetta fir-rotot kompatibbli ma’ OpenAI, tirċievi l-kontenut ta’ hawn taħt, filwaqt li error.type fir-rotot kompatibbli ma’ Anthropic ikun authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Iċċekkja l-istatus taċ-ċavetta fil-paġna taċ-ċwievet API. Jekk tkun skaduta jew revokata, oħroġ ċavetta ġdida.
- Iċċekkja jekk l-isem tal-header huwiex X-API-Key jew Authorization.
- Jekk tuża Authorization fir-rotot kompatibbli ma’ OpenAI, iċċekkja l-prefiss Bearer.