Add messages

post

Add new messages to an existing thread. Messages are provided in multimodal format and stored in Firestore format. Customer activity is automatically tracked for each message.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

customerIdstringRequired

The ID of the customer.

channelstringRequired

The channel name. Supported channels are: facebook, instagram, whatsapp, tiktok, or any channel starting with 'chatbot.' (e.g., 'chatbot.web', 'chatbot.mobile'). Note: For channels starting with 'chatbot.', the customer must have a widget_chatbot.id field.

Example: {"value":"facebook","summary":"Facebook channel"}

Body

application/json

Responses

201

Messages successfully created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/v1/agents/{agentId}/customers/{customerId}/threads/{channel}/messages

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/customers/{customerId}/threads/{channel}/messages HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 428

{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Hello, I have a question"
        }
      ]
    },
    {
      "role": "assistant",
      "content": [
        {
          "type": "text",
          "text": "Hello! How can I help you?"
        }
      ],
      "metadata": {
        "source": "automated_response",
        "confidence": 0.95
      }
    },
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Check out this image"
        },
        {
          "type": "binary",
          "mimeType": "image/jpeg",
          "url": "https://example.com/photo.jpg",
          "altText": "A sunset over the ocean"
        }
      ]
    }
  ]
}

{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "text"
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}