Skip to main content

fixedResponses

FixedResponses Model​

Represents a predefined response associated with a specific topic. These are often used to automate consistent answers to recurring inputs or predefined triggers.

id (integer, ReadOnly)​

Unique identifier for the fixed response.

topic (string) Required​

The subject or category to which the response is related.

  • Minimum length: 1 character

content (string, Required)​

The actual response content that should be returned when the topic is matched.

  • Minimum length: 1 character

name (string) Required​

The label or display name for the fixed response.

  • Minimum length: 1 character

additional_metadata (object, Optional)​

A flexible field to attach custom metadata as key-value pairs.

Example​

{
  "topic": "string",
  "content": "string",
  "name": "string",
  "additional_metadata": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}