Generate customer-facing AI agent preview reply

POST/v1/ai/agents/{agentID}/preview/messages

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

contact_idstring

messagestring

messagesAISmithMessageInput[] | null

Show properties

Array of AISmithMessageInput

contentstringrequired

Message content

rolestring

Message role (user/assistant/system)

session_idstring

Responses

200OK

agent_idstringrequired

confidence_scorenumber<double>

created_atstring

messagestringrequired

message_idstring

modelstringrequired

providerstringrequired

session_idstring

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/ai/agents/string/preview/messages" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_id": "string",
  "message": "string",
  "messages": [
    {
      "content": "string",
      "role": "string"
    }
  ],
  "session_id": "string"
}'

const response = await fetch("/v1/ai/agents/string/preview/messages", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "contact_id": "string",
  "message": "string",
  "messages": [
    {
      "content": "string",
      "role": "string"
    }
  ],
  "session_id": "string"
})
});

import requests

response = requests.post(
    "/v1/ai/agents/string/preview/messages",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "contact_id": "string",
  "message": "string",
  "messages": [
    {
      "content": "string",
      "role": "string"
    }
  ],
  "session_id": "string"
},
)

Response

{
  "agent_id": "string",
  "confidence_score": 0,
  "created_at": "string",
  "message": "string",
  "message_id": "string",
  "model": "string",
  "provider": "string",
  "session_id": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}