Developer guide
Autenticarse cunha clave de API
Cabeceira na que introducir a clave de API e URL base que configurar no SDK
Esta páxina explica como autenticarse coa clave de API na pasarela de CLEVI.
Tanto a ruta compatible con OpenAI como a ruta compatible con Anthropic autentícanse cunha única clave,
pero o alcance permitido da cabeceira na que se introduce a clave e a URL base que se debe configurar no SDK son diferentes segundo a especificación.
Cabeceira de autenticación
Ambas as especificacións compatibles autentícanse cunha única clave de API. A clave emítese na pantalla de claves de API da consola, e nesa mesma pantalla pódense xestionar a revogación e o ámbito de uso.
| Cabeceira | Compatible con OpenAI | Compatible con Anthropic |
|---|---|---|
| X-API-Key: <키> | Permitido | Permitido |
| Authorization: Bearer <키> | Permitido | Permitido |
| Authorization: <키> (sen Bearer) | Rexeitado | Permitido |
Os nomes das cabeceiras non distinguen entre maiúsculas e minúsculas. x-api-key, que envía o SDK de Anthropic, tamén funciona directamente.
URL base
Os SDK que xa utilizabas seguirán funcionando se só cambias a URL base polos enderezos seguintes. Os dous enderezos diferéncianse en se inclúen /v1.
| Especificación | URL base | Regra da ruta |
|---|---|---|
| Compatible con OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Inclúe /v1 na URL base. |
| Compatible con Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | O SDK de Anthropic engade /v1 automaticamente á ruta, polo que remata antes de /v1. |
Comprobación da autenticación
Podes comprobar inmediatamente se a autenticación funciona introducindo a clave e a URL base e consultando a lista de modelos. Os tres exemplos seguintes realizan a mesma consulta con curl, o SDK de OpenAI e o SDK de 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)No lugar de sk-... introduce a clave emitida na pantalla de claves de API.
- Se a resposta é 200, a autenticación foi correcta. data contén a lista de modelos que se poden chamar con esta clave.
- Se a resposta é 401, comproba os elementos na orde indicada na sección «Fallo de autenticación» seguinte.
Cabeceiras utilizadas conxuntamente
Todo é opcional. Para rastrexar problemas, recoméndase incluír X-Request-Id.
| Cabeceira | Uso | Se se omite |
|---|---|---|
| X-Request-Id | Identificador para rastrexar solicitudes. Nas respostas compatibles con Anthropic, devólvese como a cabeceira request-id. | Emíteo o servidor. |
| X-Region-Code | Rexión da chamada | É global. |
| X-Product-Sku (tamén dispoñible como product_sku na consulta) | Especifica directamente o Product SKU que se empregará para a facturación. A cabeceira ten prioridade sobre a consulta e úsase principalmente nas rutas de audio e voz. | É necesario nas rutas de voz. audio/speech e audio/transcriptions escollen o Product mediante o model do corpo. |
| anthropic-version / anthropic-beta | Transmítese tal cal nas rutas compatibles con Anthropic. | A versión é 2023-06-01. |
Erro de autenticación
Se non se envía ningunha clave ou se envía unha clave caducada ou revogada, prodúcese un erro 401. Se se realiza unha chamada sen clave na ruta compatible con OpenAI, recíbese o corpo seguinte; na ruta compatible con Anthropic, error.type é authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Comprobe o estado da clave na pantalla de claves da API. Se está caducada ou revogada, emita unha nova.
- Comprobe se o nome da cabeceira é X-API-Key ou Authorization.
- Se usa Authorization na ruta compatible con OpenAI, comprobe o prefixo Bearer.