v3
chats

Create chat

Start a chat with a chat agent. Without integration_connection_id the chat uses the workspace's TMS connection, when there is exactly one.

post/v3/chats

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

mentium-workspace-idstring nullable

Request body

agent_idstring uuid required

Agent to chat with; must be one of GET /v3/chat-agents

integration_connection_idstring uuid nullable

TMS connection the agent's freight tools use; defaults to the workspace's TMS connection

Response

Successful Response

idstring required
agent_idstring nullable
agent_namestring nullable

Null when the agent has since been deleted

titlestring nullable

Set from the first message

integration_connection_idstring nullable
last_message_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.