Conversation Thread

End to End Intelligent Conversation

1. Start a new Conversation.

Note: chats saving needs save to be set to true, it is false by default.

POST  /conversation/new

Headers

Name
Value

Content-Type

application/json

apiKey

string

secret

string

Body

Name
Type
Description

title

string

title or topic for the chat.

inlanguage

string

The language to begin with, can be switched updated mid conversation

outputLanguage

string

The language to get response in

responsetype

string

Can be voice, image, video or text. If you need voice and text use voice,text.

agentId

string

If you are referring to a specific agent. Its ID

stream

boolean

save

number

Chats are not saved by default.

message

string

The message to begin w

messagetype

string

The message type

{
    "title":"Testing you", 
    "inlanguage":"hausa",
    "outputlanguage":"english", 
    "responsetype":"text", 
    "agentId":"", 
    "stream":false,
    "save":true,
    "message":"Hello Bro", 
    "messagetype":"text",
 
}

2. Fetch Conversations

Fetch the list of all your saved conversations.

GET /conversations

Headers

Name
Value

Content-Type

application/json

apiKey

string

secret

string

GET /conversations


2. Fetch a specific conversation

This fetches a conversation using the specified ID number

GET /conversation/{id}

Headers

Name
Value

Content-Type

application/json

apiKey

string

secret

string

GET /conversation/id

4. Continue a saved conversation or thread.

description

POST /conversation/{id}

Headers

Content-Type

application/json

apiKey

string

secret

string

Body

Name
Type
Description

id

string

inlanguage

The language for the newest message to be updated mid conversation

outlanguage

string

The language to get response in

responsetype

string

what you need as response. Can be voice, image, video or text.

agentId

number

If you are referring to a specific agent. Its ID

stream

boolean

messages

Array[messages]

Array of messages, the one on top is the latest one

Message

Name
Type
Description

message

string

The message can be text or url of voice or video

messagetype

string

The message type, if voice specify and supply in message.

owner

string

user or machine.

topic

string

optional. instruction(to tell the machine who it is), change topic, refresh memory.


5. Delete a saved conversation or thread.

DELETE /conversation/{id}

Headers

Name
Value

Content-Type

application/json

apiKey

string

secret

string

DELETE /conversation/id

Last updated

Was this helpful?