Chatin täydentämisen API
AiHummer paljastaa yhden OpenAI-yhteensopiva HTTP-päätepiste tekstikierroksille: POST /v1/chat/completions. Mikä tahansa asiakas tai SDK, joka jo käyttää OpenAI Chat Completions -muotoa, voi kommunikoida AiHummerin kanssa vaihtamalla perus-URL-osoitteen ja API-avaimen — AiHummer-kohtaista koodia ei tarvita.
Todennus
Pyynnöt todennetaan käyttäen henkilökohtainen API-avain Bearer-tunnuksena. AiHummer-avaimet alkavat prefiksillä ah- ja ne annetaan verkkohallinnan käyttöliittymästä.
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] Perus-URL on porttisi osoite. Oletusasennuksessa portti kuuntelee julkisessa portissa
:8780, joten paikallinen puhelu meneehttp://localhost:8780/v1/chat/completions. Yhdyskäytävällä on porttinsa suoraan — käänteisen välityspalvelimen asettaminen eteen on operaattorin valinta, ei vaatimus.
Peruspyyntö
Lähetä JSON-runko mukana messages, aivan kuten tekisit OpenAI:lle. model kenttä valitsee mallin (tai agentin), joka on määritetty instanssiisi.
curl https://your-aihummer.example/v1/chat/completions \
-H "Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "default",
"messages": [
{ "role": "system", "content": "You are a helpful assistant." },
{ "role": "user", "content": "Summarise our refund policy in two sentences." }
],
"temperature": 0.3
}'
Ei-suoratoistovastaus noudattaa tuttua Chat Completion -muotoa:
{
"id": "chatcmpl-...",
"object": "chat.completion",
"created": 1750000000,
"model": "default",
"choices": [
{
"index": 0,
"message": { "role": "assistant", "content": "Refunds are issued within 14 days..." },
"finish_reason": "stop"
}
],
"usage": { "prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0 }
}
Suoratoistovastaukset (SSE)
Asettaa "stream": true vastaanottaa vastaus vähitellen samalla kun Palvelimen lähettämät tapahtumat. Jokaisella tapahtumalla on chat.completion.chunk delta, ja puro päättyy lopulliseen data: [DONE] linja.
curl -N https://your-aihummer.example/v1/chat/completions \
-H "Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "default",
"stream": true,
"messages": [
{ "role": "user", "content": "Write a one-line greeting." }
]
}'
Vastaus on a text/event-stream:
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"}}]}
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Hello"}}]}
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"!"},"finish_reason":"stop"}]}
data: [DONE]
[!WARNING]
/v1/chat/completionson se vain päätepiste on OpenAI-yhteensopiva pinta. AiHummer tekee ei altistaa/v1/modelsja tekee ei altistaa/v1/embeddings— sijoitetut kappaleet ovat sisäinen alijärjestelmä eivätkä ole saavutettavissa HTTP:n kautta. Älä luota näihin reitteihin; ne palauttavat 404.
Löytö ja kaaviopinnat
Vaikka ei ole /v1/models luettelo, AiHummer toimittaa useita löytöpintoja, jotta ihmiset ja työkalut voivat tutkia APIa:
| Polku | Mitä se palvelee |
|---|---|
GET /docs |
Ihmisen luettavissa oleva dokumentaation aloituspiste |
GET /docs/api |
Interaktiivinen API-selain |
GET /docs/openapi.json |
OpenAPI 3.x -määritelmä |
GET /openapi.json |
OpenAPI 3.x -määrittely (juuritunnisteen alias) |
GET /docs/llm.json |
Koneellisesti luettava API-yhteenveto LLM-työkaluista |
GET /llms.txt |
llms.txt indeksi LLM-agenttien varten |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
Järjestelmän päätelaitteet
Kaksi kevyt, todennuksetonta järjestelmän päätettä auttavat elinvoimaisuuden ja kellon tarkistuksissa:
| Menetelmä & polku | Tarkoitus |
|---|---|
GET /v1/ping |
Palauttaa yksinkertaisen elossaolovasteen |
GET /v1/time |
Palauttaa portin nykyisen palvelimen ajan |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
Minne seuraavaksi
- Ohjaa AiHummeria omista sovelluksistasi ja automaatioistasi: Sisääntulevat ja integrointia käynnistävät tekijät.
- Parittaminen, SSO-liittoutuma ja protokollapinnat: Webhooks, SCIM ja paritus.
- Säädä, mitä agentti voi tehdä: Työkaluluettelo.