Developer guide
Hōʻoia me ke kī API
Ke poʻomanaʻo e hoʻokomo ai i ke kī API a me ka base URL e hoʻonohonoho ai i ka SDK
Kūkākūkā kēia ʻaoʻao i ke ʻano o ka hōʻoia ʻana i CLEVI gateway me ke kī API.
Hoʻohana nā ala kūlike me OpenAI a me Anthropic i hoʻokahi kī no ka hōʻoia ʻana,
akā ʻokoʻa ka ʻae ʻia o ke poʻomanaʻo e hoʻokomo ai i ke kī a me ka base URL e hoʻonohonoho ai i ka SDK ma kēlā me kēia kūlana.
Poʻomanaʻo hōʻoia
Hoʻohana nā kūlana kūlike ʻelua i hoʻokahi kī API no ka hōʻoia ʻana. Hoʻopuka ʻia ke kī ma ka ʻaoʻao API Keys o ka console, a ma ia ʻaoʻao nō hoʻi e mālama ai i ka hoʻopau ʻana a me ka laulā o ka hoʻohana.
| Poʻomanaʻo | Kūlike me OpenAI | Kūlike me Anthropic |
|---|---|---|
| X-API-Key: <키> | ʻAe ʻia | ʻAe ʻia |
| Authorization: Bearer <키> | ʻAe ʻia | ʻAe ʻia |
| Authorization: <키> (me ka ʻole o Bearer) | Hōʻole ʻia | ʻAe ʻia |
ʻAʻole nānā ʻia ka nui a me ka liʻiliʻi o nā leka ma ka inoa o ke poʻomanaʻo. Hana pū ka x-api-key i hoʻouna ʻia e ka Anthropic SDK me ka hoʻololi ʻole.
base URL
E hoʻololi wale i ka base URL o ka SDK āu i hoʻohana ai i ka helu wahi ma lalo, a e hana mau nō ia. ʻO ka ʻokoʻa o nā helu wahi ʻelua, ʻo ia ka hoʻokomo ʻia a me ka hoʻokomo ʻole ʻia o /v1.
| Kūlana | base URL | Rula ala |
|---|---|---|
| Kūlike me OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | E hoʻokomo pū i ka /v1 a hiki i laila i ka base URL. |
| Kūlike me Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Hoʻopili ka Anthropic SDK i ka /v1 i ke ala ma kāna iho, no laila pau ma mua o /v1. |
Hōʻoia i ka hōʻoia ʻana
Ma ka hoʻokomo ʻana i ke kī a me ka base URL a me ka noi ʻana i ka papa inoa o nā model, hiki iā ʻoe ke ʻike koke inā ua hōʻoia ʻia. Hana nā mea ʻekolu ma lalo i ka noi like me curl, OpenAI SDK, a me 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)Ma kahi o sk-... e hoʻokomo i ke kī i hoʻopuka ʻia ma ka ʻaoʻao API Keys.
- Inā 200 ka pane, ua hōʻoia ʻia. Aia i loko o data ka papa inoa o nā model hiki ke kāhea ʻia me kēia kī.
- Inā 401 ka pane, e nānā ma ke kaʻina o ka ʻāpana Hāʻule ka hōʻoia ma lalo.
Poʻomanaʻo i hoʻohana pū ʻia
He koho wale nō kēia mau mea a pau. No ka huli ʻana i kahi pilikia, ʻoi aku ka maikaʻi o ka hoʻokomo ʻana iā X-Request-Id.
| Poʻomanaʻo | Kumu hoʻohana | Ke haʻalele ʻia |
|---|---|---|
| X-Request-Id | He mea kuhikuhi no ka huli ʻana i nā noi. Ma nā pane i kūlike me Anthropic, e hoʻi mai ia ma ke ʻano he poʻomanaʻo request-id. | Na ke kikowaena e hoʻopuka. |
| X-Region-Code | Ka ʻāpana no ke kāhea ʻana | ʻO global ia. |
| X-Product-Sku (hiki nō hoʻi ma ka query product_sku) | Hoʻonohonoho pololei i ka Product SKU e hoʻohana ʻia no ka uku ʻana. ʻOi aku ka mana o ke poʻomanaʻo ma mua o ka query, a hoʻohana nui ʻia ma nā ala leo a me ka voice. | Pono ia ma nā ala voice. Ma audio/speech a me audio/transcriptions, koho ʻia ka Product e ke model i loko o ke kino. |
| anthropic-version / anthropic-beta | Hoʻouna pololei ʻia ma nā ala i kūlike me Anthropic. | ʻO ka mana ʻo 2023-06-01. |
Hāʻule ka hōʻoia ʻike
Inā hoʻouna ʻia kahi kī i nalo, i pau ka wā, a i kāpae ʻia paha, ʻo 401 ka hopena. Inā kāhea ʻia ke ala i kūlike me OpenAI me ka ʻole o ke kī, e hoʻi mai ke kino ma lalo; ma ke ala i kūlike me Anthropic, ʻo authentication_error ka error.type.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- E nānā i ke kūlana o ke kī ma ka ʻaoʻao API key. Inā ua pau ka wā a i ʻole ua kāpae ʻia, e hoʻopuka hou i kī.
- E hōʻoia inā ʻo X-API-Key a i ʻole Authorization ka inoa o ke poʻomanaʻo.
- Inā hoʻohana ʻia ʻo Authorization ma ke ala i kūlike me OpenAI, e hōʻoia i ka prefix Bearer.
