Twimi
API Twimi v1
API Twimi v1

Questions et réponses

Server
Download schema

Poser la question du visiteur à l'IA de Twimi ; la réponse arrive en flux (SSE).

Poser une question à l'avatar

POST
https://api-dev.atwimi.com
/v1/conversations/{conversation_id}/messages
Bearer (JWT)

Avec le jeton de conversation. Formules Avatar Widget et Avatar Agent. Réponse en flux (text/event-stream), une ligne data: {...} par événement :

  • token {text} : morceau de la réponse, à afficher au fil de l'eau ;
  • done {text, products, turn, voice} : réponse complète, articles cités, numéro du tour (à redonner à /speech pour chaque morceau de cette réponse), voix disponible ou non pour la dire ;
  • error {code, message} : réponse impossible (brain_unavailable). 20 questions par minute et par conversation.

Poser une question à l'avatar › path Parameters

conversation_id
​string · required

Poser une question à l'avatar › Request Body

MessageIn
message
​string · minLength: 1 · maxLength: 1000 · required

Question du visiteur (tapée ou transcrite).

lang
​string | null · maxLength: 8

Accepté, sans effet en v1 : l'avatar répond dans la langue de la question, détectée à chaque message.

mode
​string · enum

« voice » : réponse rédigée pour être dite à voix haute.

Enum values:
text
voice
Default: text
page
​string | null · maxLength: 500

Page consultée par le visiteur (accueil et réponses selon la page).

Poser une question à l'avatar › Responses

Réponse en flux : une ligne data: {...} par événement (token, done ou error).

string
ConversationsVoix