Loading
Vie botti oman sovelluksesi, taustajärjestelmäsi tai sisäisen työkalusi sisään: aloita keskusteluja, lähetä viestejä, lataa liitteitä.
REST-rajapinta on tarkoitettu botin viemiseen oman tuotteesi sisään: mobiilisovellukseesi, taustajärjestelmääsi tai sisäiseen työkaluusi. Jos haluat vain chat-kuplan verkkosivustollesi, et tarvitse tätä sivua lainkaan, koodinpätkä hoitaa kaiken puolestasi.
Perus-URL https://equilai.ai/api/chat. Luo API-avain kohdassa Hallintapaneeli → API, lähetä se x-api-key-otsakkeena (tai JSON-rungossa kenttänä apiKey), ja pidä se palvelimellasi, ei koskaan selainkoodissa. API-pääsyn on oltava käytössä paketissasi. Katso Todennus →
Päätepiste 1
Hae, mihin bottiin API-avaimesi kuuluu, sen id:n ja nimen kanssa, jotta tiedät tarkalleen minkä botin integroit. Jokainen avain vastaa yhtä bottia.
Pyyntö
GET https://equilai.ai/api/chat/bots
x-api-key: YOUR_API_KEYVastaus
{
"bots": [
{
"id": "019ec65b-f266-7e44-849c-d8ed300802e4",
"name": "Aria",
"label": "Production support bot"
}
]
}Päätepiste 2
Luo keskustelusessio. Palauttaa conversationId:n, joka annetaan jokaisen viestin mukana. Mitään ei tallenneta ennen ensimmäistä viestiä, joten joutilaat sessiot eivät laske kuukausirajaasi.
Pyyntö
POST https://equilai.ai/api/chat/start
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY"
}Vastaus
{
"message": "Successfully started a new conversation",
"conversationId": "5691c459..."
}Päätepiste 3
Lähetä käyttäjän viesti ja vastaanota tekoälyn vastaus kentässä response. Anna sama apiKey ja aloituskutsun conversationId. message voi olla enintään 2 000 merkkiä pitkä; pidempi viesti hylätään koodilla 400. attachmentIds on valinnainen ja viittaa alla olevan päätepisteen kautta ladattuihin tiedostoihin (enintään 4 per viesti); viesti voi olla myös pelkkä liite tyhjällä message-kentällä.
Pyyntö
POST https://equilai.ai/api/chat/bot
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY",
"conversationId": "5691c459...",
"message": "What is on this receipt?",
"attachmentIds": ["0197b1c2-..."]
}Vastaus
{
"response": "We're open Monday to Friday, 9 am to 6 pm."
}Päätepiste 4
Lataa kuva tai PDF (enintään 10 Mt) muodossa multipart/form-data, ja anna sitten palautettu id seuraavan viestin attachmentIds-kentässä. Botti lukee kuvat suoraan (sen malli tukee näkökykyä) ja poimii tekstin PDF-tiedostoista. Tiedostot poistetaan 7 päivän jälkeen. Kun botin henkilötietojen poisto on päällä, PDF-tiedostosta säilytetään vain sen teksti, josta tunnistetut henkilötiedot on poistettu: alkuperäistä tiedostoa ei tallenneta, joten url on null ja originalDiscarded on true.
Pyyntö
POST https://equilai.ai/api/chat/upload
Content-Type: multipart/form-data
x-api-key: YOUR_API_KEY
file: (binary, max 10 MB)Vastaus
{
"attachment": {
"id": "0197b1c2-...",
"kind": "image",
"name": "receipt.png",
"size": 48213,
"url": "https://equilai.ai/uploads/chat/0197b1c2-....png",
"expired": false,
"originalDiscarded": false
}
}Pikatesti
Kopioi avaimesi hallintapaneelista ja suorita:
curl -X POST "https://equilai.ai/api/chat/start" \
-H "Content-Type: application/json" \
-d '{"apiKey": "YOUR_API_KEY"}'Haluatko vain lisätä chat-kuplan sivustollesi? Katso Asennus →