Developer guide
Autenticació amb una clau d’API
Capçaleres on s’introdueix la clau d’API i l’URL base que cal configurar a l’SDK
Aquesta pàgina explica com autenticar-se amb una clau d’API a la passarel·la de CLEVI.
Tant la ruta compatible amb OpenAI com la ruta compatible amb Anthropic s’autentiquen amb una sola clau,
però l’abast admès de la capçalera on s’introdueix la clau i l’URL base que cal configurar a l’SDK varien segons l’especificació.
Capçaleres d’autenticació
Ambdues especificacions compatibles s’autentiquen amb una sola clau d’API. La clau s’emet a la pantalla de claus d’API de la consola, on també se’n gestionen la revocació i l’abast d’ús.
| Capçalera | Compatible amb OpenAI | Compatible amb Anthropic |
|---|---|---|
| X-API-Key: <키> | Admesa | Admesa |
| Authorization: Bearer <키> | Admesa | Admesa |
| Authorization: <키> (sense Bearer) | Rebutjada | Admesa |
El nom de la capçalera no distingeix entre majúscules i minúscules. x-api-key, que envia l’SDK d’Anthropic, també funciona tal qual.
URL base
Els SDK que ja utilitzeu continuaran funcionant si només canvieu l’URL base per una de les adreces següents. Les dues adreces es diferencien pel fet d’incloure o no /v1.
| Especificació | URL base | Regla de la ruta |
|---|---|---|
| Compatible amb OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Incloeu fins a /v1 a l’URL base. |
| Compatible amb Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | L’SDK d’Anthropic afegeix /v1 automàticament a la ruta, de manera que l’URL acaba abans de /v1. |
Verificació de l’autenticació
Podeu comprovar immediatament si l’autenticació funciona introduint la clau i l’URL base i consultant la llista de models. Els tres exemples següents fan la mateixa consulta amb curl, l’SDK d’OpenAI i l’SDK d’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"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)Introduïu al lloc de sk-... la clau emesa a la pantalla de claus d’API.
- Si la resposta és 200, l’autenticació s’ha completat correctament. data conté la llista de models que es poden invocar amb aquesta clau.
- Si la resposta és 401, comproveu-ho seguint l’ordre de la secció sobre errors d’autenticació que hi ha a continuació.
Capçaleres utilitzades conjuntament
Tots són opcionals. Per fer el seguiment dels problemes, és recomanable incloure X-Request-Id.
| Capçalera | Ús | Si s’omet |
|---|---|---|
| X-Request-Id | Identificador per fer el seguiment de les sol·licituds. En les respostes compatibles amb Anthropic, es retorna com a capçalera request-id. | L’emet el servidor. |
| X-Region-Code | Regió de la sol·licitud | És global. |
| X-Product-Sku (també disponible com a product_sku a la consulta) | Especifica directament el Product SKU que s’utilitzarà per a la facturació. La capçalera té prioritat sobre la consulta i s’utilitza principalment en les rutes de veu. | És necessari en les rutes de veu. audio/speech i audio/transcriptions seleccionen el Product mitjançant el model del cos de la sol·licitud. |
| anthropic-version / anthropic-beta | Es transmeten tal qual en les rutes compatibles amb Anthropic. | La versió és 2023-06-01. |
Error d’autenticació
Si no s’envia cap clau o s’envia una clau caducada o revocada, es produeix un error 401. Si es fa una crida sense clau a la ruta compatible amb OpenAI, es rep el cos següent, i el valor de error.type a la ruta compatible amb Anthropic és authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Comproveu l’estat de la clau a la pantalla de claus de l’API. Si ha caducat o ha estat revocada, n’emeteu una de nova.
- Comproveu que el nom de la capçalera sigui X-API-Key o Authorization.
- Si feu servir Authorization a la ruta compatible amb OpenAI, comproveu el prefix Bearer.