Developer guide
Pag-authenticate gamit ang API key
Header nga butangan sa API key ug base URL nga i-set sa SDK
Kini nga panid naghisgot kung giunsa pag-authenticate sa CLEVI gateway gamit ang API key.
Ang OpenAI-compatible nga agianan ug Anthropic-compatible nga agianan parehas nga naggamit og usa ka key para sa authentication,
apan lahi ang gitugot nga mga header nga butangan sa key ug ang base URL nga i-set sa SDK depende sa espesipikasyon.
Authentication header
Ang duha ka compatible nga espesipikasyon naggamit og usa ka API key para sa authentication. Ang key i-isyu sa API key screen sa console, ug sa samang screen mahimong dumalahon ang pag-revoke ug sakop sa paggamit.
| Header | OpenAI-compatible | Anthropic-compatible |
|---|---|---|
| X-API-Key: <키> | Gitugotan | Gitugotan |
| Authorization: Bearer <키> | Gitugotan | Gitugotan |
| Authorization: <키> (walay Bearer) | Gisalikway | Gitugotan |
Dili sensitibo sa uppercase o lowercase ang ngalan sa header. Ang x-api-key nga ipadala sa Anthropic SDK molihok usab diretso.
base URL
Ang SDK nga imong gigamit magpadayon sa pagtrabaho kung ilisan lang ang base URL sa adres sa ubos. Lahi ang duha ka adres kon apil ba niini ang /v1.
| Espesipikasyon | base URL | Lagda sa path |
|---|---|---|
| OpenAI-compatible | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Iapil ang /v1 sa base URL. |
| Anthropic-compatible | https://platform.clevi.net/api/v2/aiservice/anthropic | Ang Anthropic SDK mismo ang modugang og /v1 sa path, busa matapos kini sa wala pa ang /v1. |
Pagkumpirma sa authentication
Kung i-set ang key ug base URL ug pangitaon ang listahan sa mga modelo, mahibalo dayon ka kung na-authenticate ba. Ang tulo sa ubos mohimo sa samang pagpangita gamit ang curl, OpenAI SDK, ug 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)Ibutang ang key nga gi-isyu sa API key screen sa dapit sa sk-....
- Kung 200 ang tubag, na-authenticate na. Ang data naglangkob sa listahan sa mga modelo nga mahimong tawgon gamit kini nga key.
- Kung 401 ang tubag, susiha kini sumala sa han-ay sa seksyon nga Napakyas ang authentication sa ubos.
Mga header nga gamiton dungan
Opsyonal ra tanan. Aron masubay ang problema, mas maayong ibutang ang X-Request-Id.
| Header | Gamit | Kung dili iapil |
|---|---|---|
| X-Request-Id | Identifikador alang sa pagsubay sa hangyo. Sa mga tubag nga kompatible sa Anthropic, ibalik kini isip request-id header. | Gihatag kini sa server. |
| X-Region-Code | Rehiyon sa pagtawag | global kini. |
| X-Product-Sku (mahimo usab pinaagi sa query nga product_sku) | Direktang nagtino sa Product SKU nga gamiton sa pagsingil. Mas prayoridad ang header kaysa sa query, ug kasagarang gamiton sa mga voice path. | Gikinahanglan kini sa voice path. Sa audio/speech ug audio/transcriptions, pilion ang Product pinaagi sa model sa lawas sa hangyo. |
| anthropic-version / anthropic-beta | Direktang ipasa kini sa Anthropic-compatible path. | Ang bersyon kay 2023-06-01. |
Napakyas ang awtorisasyon
Kung walay yawe o nagpadala ka og yawe nga na-expire o gibawi na, 401 ang resulta. Kung motawag nga walay yawe sa OpenAI-compatible path, madawat ang lawas sa ubos, ug ang error.type sa Anthropic-compatible path kay authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Susihon ang kahimtang sa yawe sa screen sa API key. Kung na-expire o gibawi na, paghimo og bag-ong yawe.
- Susihon kung X-API-Key o Authorization ang ngalan sa header.
- Kung mogamit og Authorization sa OpenAI-compatible path, susihon ang Bearer prefix.
