REST-rajapinta

Päätepiste 1

Listaa bottisi

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_KEY

Vastaus

{
  "bots": [
    {
      "id": "019ec65b-f266-7e44-849c-d8ed300802e4",
      "name": "Aria",
      "label": "Production support bot"
    }
  ]
}

Päätepiste 2

Aloita keskustelu

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ä viesti

Lähetä käyttäjän viesti ja vastaanota tekoälyn vastaus kentässä response. Anna sama apiKey ja aloituskutsun conversationId. 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 liite

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.

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
  }
}

Pikatesti

Yhden rivin cURL

Kopioi avaimesi hallintapaneelista ja suorita:

curl -X POST "https://equilai.ai/api/chat/start" \
     -H "Content-Type: application/json" \
     -d '{"apiKey": "YOUR_API_KEY"}'

Virhekoodit