Developer guide
Otantifye ak yon kle API
Antèt kote pou mete kle API a ak base URL pou konfigirasyon nan SDK la
Paj sa a eksplike kijan pou otantifye sou pòtay CLEVI a ak yon kle API.
Tou de chemen ki konpatib ak OpenAI ak chemen ki konpatib ak Anthropic itilize yon sèl kle pou otantifikasyon,
men seri antèt kote pou mete kle a ak base URL pou konfigirasyon nan SDK la diferan selon spesifikasyon an.
Antèt otantifikasyon
Tou de espesifikasyon konpatib yo itilize yon sèl kle API pou otantifikasyon. Ou bay kle a sou ekran kle API nan konsole a, epi ou jere anilasyon li ak seri itilizasyon li sou menm ekran an.
| Antèt | Konpatib ak OpenAI | Konpatib ak Anthropic |
|---|---|---|
| X-API-Key: <키> | Aksepte | Aksepte |
| Authorization: Bearer <키> | Aksepte | Aksepte |
| Authorization: <키> (Bearer 없이) | Refize | Aksepte |
Non antèt la pa sansib ak majiskil/miniskil. x-api-key SDK Anthropic la voye a fonksyone jan li ye a tou.
base URL
SDK w t ap itilize a ap kontinye fonksyone si w sèlman chanje base URL la pou adrès ki anba a. De adrès yo diferan selon si yo gen /v1 ladan yo oswa non.
| Spesifikasyon | base URL | Règ chemen |
|---|---|---|
| Konpatib ak OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Mete /v1 la ladan base URL la. |
| Konpatib ak Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | SDK Anthropic la ajoute /v1 poukont li nan chemen an, kidonk li fini anvan /v1. |
Verifye otantifikasyon
Ou ka konnen imedyatman si otantifikasyon an reyisi lè w mete kle a ak base URL la epi w rekipere lis modèl yo. Twa egzanp ki anba yo fè menm rekèt la ak curl, OpenAI SDK ak 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)Mete kle yo bay sou ekran kle API a nan plas sk-... la.
- Si repons lan se 200, otantifikasyon an reyisi. data a gen lis modèl ou ka rele ak kle sa a.
- Si repons lan se 401, verifye li selon lòd ki nan seksyon Echèk otantifikasyon an anba a.
Antèt yo itilize ansanm
Tout se opsyonèl. Pou swiv pwoblèm yo, li pi bon pou mete X-Request-Id.
| Antèt | Itilizasyon | Si yo omèt li |
|---|---|---|
| X-Request-Id | Idantifyan pou swiv demann lan. Pou repons ki konpatib ak Anthropic, li retounen kòm antèt request-id. | Sèvè a bay li. |
| X-Region-Code | Rejyon apèl la | Li se global. |
| X-Product-Sku (li posib tou kòm product_sku nan paramèt rechèch la) | Espesifye dirèkteman Product SKU pou itilize pou faktirasyon. Antèt la gen priyorite sou paramèt rechèch la epi yo itilize li sitou pou wout vwa ak vwa. | Li nesesè pou wout vwa yo. Pou audio/speech ak audio/transcriptions, yo chwazi Product la ak model ki nan kò a. |
| anthropic-version / anthropic-beta | Yo transmèt yo san chanjman sou wout ki konpatib ak Anthropic. | Vèsyon an se 2023-06-01. |
Echèk otantifikasyon
Si ou voye yon kle ki manke, ki ekspire oswa ki revoke, sa bay 401. Si ou fè yon apèl san kle sou wout ki konpatib ak OpenAI, w ap resevwa kò ki anba a; pou wout ki konpatib ak Anthropic, error.type se authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Tcheke estati kle a nan ekran kle API a. Si kle a ekspire oswa li revoke, bay yon nouvo kle.
- Verifye si non antèt la se X-API-Key oswa Authorization.
- Si ou itilize Authorization sou wout ki konpatib ak OpenAI, verifye prefiks Bearer la.