Chatbot WebSocket API 0.5.1 documentation

Chatbot WebSocket API 0.5.1

WebSocket API for managing real-time chatbot connections and messaging.

Servers

wss://chatbot.live.prod.brandbrain.satalia.io/wssLive
Live WebSocket API server.
Security:
HTTP API key
Name: x-api-key
In: header
#Live

Operations

SEND $connect
Client establishes a WebSocket connection.

Establish a WebSocket connection.
Operation IDestablishConnection
Available only on servers:
- Live
- #Connection Management
Accepts the following message:
SEND $disconnect
Client disconnects from the WebSocket.

Disconnect from the WebSocket.
Operation IDdisconnectConnection
Available only on servers:
- Live
- #Connection Management
Accepts the following message:
SEND connection-info
Clients request information about their WebSocket connection.

Request connection information.
Operation IDgetConnectionInfo
Available only on servers:
- Live
- #Connection Management
Accepts the following message:
application/json
Message IDconnectionInfoRequest.message
object
action
required
string
The action to perform.

Allowed values:
"connection-info"
Additional properties are NOT allowed.
Examples
{ "action": "connection-info" }

This example has been generated automatically.
RECEIVE connection-info
Clients request information about their WebSocket connection.

Receive connection information.
Operation IDreceiveConnectionInfo
Available only on servers:
- Live
- #Connection Management
Accepts the following message:
application/json
Message IDconnectionInfoResponse.message
object
connection_id
required
string
non-empty
The unique connection ID.

connected_at
required
string
format: date-timemust match: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z
The timestamp when the connection was established. Timestamps must follow format of YYYY-MM-DDTHH:MM:SSZ.

ttl
required
integer
>= 1
The time-to-live (TTL) value for the connection. This is an Unix/Epoch timestamp.

expires_at
required
string
format: date-timemust match: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z
The timestamp when the connection will expire. Timestamps must follow format of YYYY-MM-DDTHH:MM:SSZ.

Additional properties are NOT allowed.
Examples
{ "connection_id": "string", "connected_at": "2019-08-24T14:15:22Z", "ttl": 1, "expires_at": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
SEND send-message
Clients send messages to the chatbot.

Send a message to the chatbot.
Operation IDsendMessage
Available only on servers:
- Live
- #Messages
Accepts the following message:
application/json
Message IDsendMessage.message
object
action
required
string
The action to perform.

Allowed values:
"send-message"
conversation_id
required
string
format: uuidnon-empty
The ID of the conversation.

message_id
required
string
format: uuidnon-empty
The unique identifier for this message.

username
required
string
non-empty
The username of the sender.

feature_id
string | null
non-empty
The feature to use within the request.
This helps the chatbot to understand the context of the message.

Some examples of features include:

social_media_post - social media post generation.

text_variation - generate variations of text.

improve_brief - improve a brief.

interrogate_brief - interrogate a brief.

content
required
string
non-empty
The content of the message.

array<string>
>= 0 items
The document IDs to use with the request.

Items:
string
format: uuidnon-empty
A document ID referencing a document uploaded using the 'request-upload' endpoint.

array<string>
>= 0 items
The document contexts to use with the request.
This will be used in conjunction with document contents referenced by the document_ids field.

Items:
string
non-empty
The content of a context document.

role
required
string
The role of the sender.

Allowed values:
"user"
message_datetime
required
string
format: date-timemust match: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z
The date and time the message was sent. Timestamps must follow format of YYYY-MM-DDTHH:MM:SSZ.

Additional properties are NOT allowed.
Examples
{ "action": "send-message", "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407", "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2", "username": "string", "feature_id": "string", "content": "string", "document_ids": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "document_contexts": [ "string" ], "role": "user", "message_datetime": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
RECEIVE send-message
Clients send messages to the chatbot.

Receive a message from the chatbot.
Operation IDreceiveMessage
Available only on servers:
- Live
- #Messages
Accepts the following message:
application/json
Message IDreceiveMessage.message
object oneOf
restricted any
message_id
required
string
format: uuidnon-empty
The unique identifier for this message.

message_type
required
string
The type of message.

Allowed values:
"INTERIM_THOUGHT"
"FINAL_THOUGHT"
"RESPONSE_START"
"RESPONSE_END"
"RESPONSE_CHUNK"
content
string
non-empty
The content of the message.

role
required
string
The role of the sender.

Allowed values:
"assistant"
"system"
message_datetime
required
string
format: date-timemust match: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z
The date and time the message was sent. Timestamps must follow format of YYYY-MM-DDTHH:MM:SSZ.

restricted any
message_type
required
string
The type of message.

Allowed values:
"TERMINAL_ERROR"
"NON_TERMINAL_ERROR"
"WARNING"
code
required
string
non-empty
A constant string representing the specific error type.

message
required
string
non-empty
A clear, human-readable description of the error.

object
non-empty
Additional properties are allowed.
Additional properties are NOT allowed.
Examples
{ "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2", "message_type": "INTERIM_THOUGHT", "content": "string", "role": "assistant", "message_datetime": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
SEND request-upload
Clients request an upload link for sending files.

Request an upload link.
Operation IDrequestUpload
Available only on servers:
- Live
- #File Management
Accepts the following message:
application/json
Message IDrequestUpload.message
object
action
required
string
The action to perform.

Allowed values:
"request-upload"
conversation_id
required
string
format: uuidnon-empty
The ID of the conversation.

document_id
required
string
format: uuidnon-empty
The ID of the document being uploaded.

username
required
string
non-empty
The username of the sender.

filename
required
string
non-empty
The name of the file being uploaded.

mime_type
required
string
The MIME type of the file.

Allowed values:
"text/plain"
"text/markdown"
"application/pdf"
"application/msword"
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
"application/vnd.ms-powerpoint"
"application/vnd.openxmlformats-officedocument.presentationml.presentation"
size_bytes
required
integer
The size of the file in bytes.

Additional properties are NOT allowed.
Examples
{ "action": "request-upload", "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407", "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6", "username": "string", "filename": "string", "mime_type": "text/plain", "size_bytes": 0 }

This example has been generated automatically.
RECEIVE request-upload
Clients request an upload link for sending files.

Server responds with an upload link.
Operation IDuploadResponse
Available only on servers:
- Live
- #File Management
Accepts the following message:
application/json
Message IDupload_response.message
object
upload_url
required
string
non-empty
The pre-signed URL for file upload.

expires_in
required
integer
The expiration time of the upload URL in seconds.

Additional properties are NOT allowed.
Examples
{ "upload_url": "string", "expires_in": 0 }

This example has been generated automatically.

Chatbot WebSocket API 0.5.1

Servers

Security:

Operations

SEND $connect

SEND $disconnect

SEND connection-info

Examples

This example has been generated automatically.

RECEIVE connection-info

Examples

This example has been generated automatically.

SEND send-message

Examples

This example has been generated automatically.

RECEIVE send-message

Examples

This example has been generated automatically.

SEND request-upload

Examples

This example has been generated automatically.

RECEIVE request-upload

Examples

This example has been generated automatically.