Autenticarse cunha clave de API

A pasarela CLEVI autentica as rutas compatibles con OpenAI e as rutas compatibles con Anthropic cunha única clave de API.
No cliente hai que configurar dous valores: o encabezado de autenticación que contén a clave e o base URL do SDK. Os formatos de encabezado e os base URL permitidos varían segundo a especificación.
Despois de completar a configuración, pode comprobar inmediatamente se a autenticación funciona consultando a lista de modelos.
Se a autenticación falla, devolve 401; se a autenticación se supera pero non se cumpren os permisos ou os límites, devolve 403.

Emita a clave de API na pantalla de claves de API da consola. Na mesma pantalla pode xestionar a revogación da clave e o seu ámbito de uso.

Encabezado de autenticación

Ambas as especificacións inclúen a clave de API nun único encabezado da solicitude. Pode usar o encabezado X-API-Key ou o encabezado Authorization; o formato permitido depende da especificación.

Ao usar o encabezado Authorization na ruta compatible con OpenAI, é necesario o prefixo Bearer. Se envía só a clave sen o prefixo, a pasarela rexeita a solicitude.

Os nomes dos encabezados non distinguen entre maiúsculas e minúsculas, polo que o encabezado x-api-key que envía o SDK de Anthropic tamén funciona directamente. Se especifica ambos os encabezados, aplícase primeiro o valor de X-API-Key.

base URL

Os SDK que xa utilizaba poden seguir funcionando simplemente cambiando o base URL polos enderezos seguintes. Os dous enderezos diferéncianse en se inclúen /v1, polo que debe especificar directamente o enderezo correspondente á especificación.

Comprobar a autenticación

Despois de configurar a clave e a URL base, pode comprobar se a autenticación é correcta consultando a lista de modelos. Os exemplos seguintes executan a mesma consulta con curl, OpenAI SDK e Anthropic SDK. Substitúa sk-... pola clave emitida na pantalla de claves da API.

Ao facer a consulta con curl, especifique a ruta completa ata /v1/models en ambos os estándares. O primeiro comando usa o encabezado X-API-Key na ruta compatible con OpenAI, e o segundo usa o encabezado Authorization na ruta compatible con 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"

En OpenAI SDK, especifique no enderezo de base_url un enderezo que inclúa /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)

En Anthropic SDK, especifique base_url cun enderezo que remate antes de /v1.
Para a autenticación, use tal cal o encabezado x-api-key que envía o SDK.

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)

Se a resposta de calquera dos exemplos é 200, a autenticación foi correcta e data na resposta contén a lista de modelos que se poden chamar con esta clave. Se recibe 401, comprobe a causa seguindo a orde indicada na sección seguinte.

Erro de autenticación

Se non se envía ningunha clave ou se envía unha clave caducada ou revogada, devólvese 401. Se se fai unha chamada sen clave na ruta compatible con OpenAI, devólvese o corpo seguinte; na ruta compatible con Anthropic, error.type é authentication_error.

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

Se recibe 401, comprobe o seguinte nesta orde.

1. Comprobe o estado da clave na pantalla de claves da API. Se a clave caducou ou foi revogada, emita unha nova.
2. Comprobe se o nome do encabezado é X-API-Key ou Authorization.
3. Se usa o encabezado Authorization na ruta compatible con OpenAI, comprobe se inclúe o prefixo Bearer.

Despois de facer as modificacións, volva executar a consulta da lista de modelos da sección de comprobación da autenticación e confirme que recibe 200.

Encabezados que se usan conxuntamente

Todos os encabezados seguintes son opcionais. Recomendamos especificar X-Request-Id para poder rastrexar os problemas.

Se se repiten os erros 5xx, comunícao coa axuda e o contacto, xunto co X-Request-Id. Se especificaches o valor directamente, poderás contrastalo de inmediato cos rexistros do cliente.