Developer guide
S’autentificar amb una clau API
L’entèstament que conten la clau API e l’URL de basa de configurar dins lo SDK
Aquesta pagina tracta de la manièra d’autentificar-se amb una clau API al passadís CLEVI.
Los camins compatibles amb OpenAI e los compatibles amb Anthropic s’autentifican totes dos amb una sola clau,
mas l’espandida autorizada de l’entèstament que conten la clau e l’URL de basa de configurar dins lo SDK diferisson segon l’estandard.
Entèstament d’autentificacion
Los dos estandards compatibles s’autentifican amb una sola clau API. La clau es emesa dempuèi l’ecran de las claus API de la consòla, e podètz tanben la revocar e gerir son espandida d’utilizacion dempuèi lo meteis ecran.
| Entèstament | Compatible amb OpenAI | Compatible amb Anthropic |
|---|---|---|
| X-API-Key: <clau> | Disponible | Disponible |
| Authorization: Bearer <clau> | Disponible | Disponible |
| Authorization: <clau> (sens Bearer) | Regetat | Disponible |
Lo nom de l’entèstament ignòra las majusculas e minusculas. x-api-key mandat pel SDK Anthropic fonciona tanben sens modificacion.
URL de basa
Lo SDK qu’utilizatz ja pòt èsser emplegat tal coma es en remplaçant sonque l’URL de basa per l’adreça çai-jós. Las doas adreças diferisson per la preséncia de /v1.
| Estandard | URL de basa | Règla dels camins |
|---|---|---|
| Compatible amb OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Incluissètz /v1 dins l’URL de basa. |
| Compatible amb Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Lo SDK Anthropic ajusta automaticament /v1 al camin, doncas l’URL s’acaba abans de /v1. |
Verificacion de l’autentificacion
Podètz verificar immediatament l’autentificacion en inserint la clau e l’URL de basa e en consultant la lista dels modèls. Los tres exemples çai-jós fan la meteissa consulta amb curl, l’SDK OpenAI e l’SDK 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)Remplaçatz sk-... per la clau emesa dempuèi l’ecran de las claus API.
- Se la responsa es 200, l’autentificacion es reüssida. data conten la lista dels modèls que pòdon èsser apelats amb aquesta clau.
- Se la responsa es 401, verificatz los elements dins l’òrdre indicat a la seccion «Fracàs de l’autentificacion» çai-jós.
Entèstaments utilizats ensems
Tot aquò es opcional. Per seguir los problèmas, es recomandat d’inclure X-Request-Id.
| Entèsta | Utilitat | Se s’omet |
|---|---|---|
| X-Request-Id | Identificant per seguir las requèstas. Dins las responsas compatibles amb Anthropic, es renviat coma entèsta request-id. | Lo servidor l’emet. |
| X-Region-Code | Region de l’apèl | Es global. |
| X-Product-Sku ( tanben possible amb la requèsta product_sku) | Especifica dirèctament lo Product SKU d’utilizar per la facturacion. L’entèsta a prioritat sus la requèsta e s’utiliza subretot pels camins de votz. | Es necessari pels camins de votz. audio/speech e audio/transcriptions seleccionan lo Product amb lo model del còs. |
| anthropic-version / anthropic-beta | Son transmeses talas qualas pels camins compatibles amb Anthropic. | La version es 2023-06-01. |
Fracàs de l’autentificacion
Se mandatz una clau absenta, expirada o revocada, obtendretz una responsa 401. Se fasètz una apèl sens clau pel camin compatible amb OpenAI, recebetz lo còs çai-jós; lo camin compatible amb Anthropic utiliza authentication_error coma error.type.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Verificatz l’estat de la clau dins l’ecran de las claus API. Se la clau es expirada o revocada, generatz-ne una novèla.
- Verificatz que lo nom de l’entèsta siá X-API-Key o Authorization.
- Se utilizatz Authorization pel camin compatible amb OpenAI, verificatz lo prefix Bearer.