Developer guide
Mag-authenticate gamit ang API key
Header na lalagyan ng API key at base URL na ise-set sa SDK
Ipinapaliwanag ng pahinang ito kung paano mag-authenticate sa CLEVI gateway gamit ang API key.
Gumagamit ng iisang key ang parehong OpenAI-compatible na path at Anthropic-compatible na path para sa authentication,
ngunit magkaiba sa bawat specification ang mga pinapayagang header na lalagyan ng key at ang base URL na ise-set sa SDK.
Authentication header
Gumagamit ang parehong compatible specification ng iisang API key para sa authentication. Iniisyu ang key sa API key screen ng console, kung saan maaari ring pamahalaan ang pag-revoke at saklaw ng paggamit nito.
| Header | OpenAI-compatible | Anthropic-compatible |
|---|---|---|
| X-API-Key: <키> | Magagamit | Magagamit |
| Authorization: Bearer <키> | Magagamit | Magagamit |
| Authorization: <키> (walang Bearer) | Tinatanggihan | Magagamit |
Hindi case-sensitive ang pangalan ng header. Gumagana rin nang direkta ang x-api-key na ipinapadala ng Anthropic SDK.
base URL
Magagamit pa rin ang SDK na ginagamit mo sa pamamagitan lamang ng pagpapalit ng base URL sa address sa ibaba. Magkaiba ang dalawang address kung kasama ang /v1.
| Specification | base URL | Mga panuntunan sa path |
|---|---|---|
| OpenAI-compatible | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Isama ang /v1 hanggang sa base URL. |
| Anthropic-compatible | https://platform.clevi.net/api/v2/aiservice/anthropic | Awtomatikong idinadagdag ng Anthropic SDK ang /v1 sa path, kaya nagtatapos ito bago ang /v1. |
Pag-verify ng authentication
Malalaman agad kung authenticated ka sa pamamagitan ng paglalagay ng key at base URL at pagkuha sa listahan ng mga modelo. Isinasagawa ng tatlong halimbawa sa ibaba ang parehong pagkuha gamit ang curl, OpenAI SDK, at 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)Sa puwesto ng sk-..., ilagay ang key na iniisyu sa API key screen.
- Kapag 200 ang response, authenticated ka. Nasa data ang listahan ng mga modelong maaaring tawagan gamit ang key na ito.
- Kapag 401 ang response, tingnan ayon sa pagkakasunod-sunod sa seksyong Nabigong authentication sa ibaba.
Mga header na ginagamit nang magkasama
Opsyonal ang lahat ng ito. Para masubaybayan ang mga problema, mainam na isama ang X-Request-Id.
| Header | Gamit | Kung aalisin |
|---|---|---|
| X-Request-Id | Identifier para sa pagsubaybay ng request. Sa mga tugon na compatible sa Anthropic, ibinabalik ito bilang request-id header. | Ibinibigay ng server. |
| X-Region-Code | Rehiyon ng tawag | global. |
| X-Product-Sku (maaari rin sa query na product_sku) | Direktang tinutukoy ang Product SKU na gagamitin para sa pagsingil. Mas inuuna ang header kaysa query at pangunahing ginagamit sa mga voice path. | Kailangan sa voice path. Sa audio/speech at audio/transcriptions, pinipili ang Product gamit ang model sa katawan ng request. |
| anthropic-version / anthropic-beta | Ipinapasa ito nang hindi binabago sa mga path na compatible sa Anthropic. | Ang bersyon ay 2023-06-01. |
Nabigong authentication
Kapag walang key o nagpadala ng expired o binawing key, 401 ang ibinabalik. Kapag tumawag nang walang key sa OpenAI-compatible path, matatanggap ang sumusunod na katawan, at ang error.type sa Anthropic-compatible path ay authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Suriin ang status ng key sa screen ng API key. Kung expired o binawi ang key, gumawa ng bago.
- Suriin kung X-API-Key o Authorization ang pangalan ng header.
- Kung gagamit ng Authorization sa OpenAI-compatible path, tiyaking may Bearer prefix.