Skip to main content

PromptCreate

A prompt is a versioned LLM instruction belonging to an agent. Each prompt has a type (chatbot "prompt", classification, document, ping, calendar, state, outreach, stage_triggered, redirect, clarification, custom_follow_up) and one active version.

textTextrequired

The initial prompt text (becomes the first version's content).

nameNamerequired

Human-readable prompt name.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

author object

Who authored the prompt.

anyOf
string
typeTyperequired

The prompt's purpose/type (see PromptType).

Possible values: [prompt, classification, document, ping, calendar, state, outreach, stage_triggered, redirect, clarification, human_clarification_follow_up, custom_follow_up, formatting, qualification, disqualification, escalation]

version_description object

Optional description for the created version.

anyOf
string
document_type object

For prompts of type "document", which document type they apply to.

anyOf
string
langLanguage

Language of the prompt.

Possible values: [ru, en, pt, es]

Default value: ru
modalityModality

Which conversation modality the prompt serves — text (default, chat channels) or voice (voice-call runtime).

Possible values: [text, voice]

Default value: text
skip_instructions object

For ping/reminder/stage-triggered prompts, natural-language instructions describing when to skip sending.

anyOf
string
PromptCreate
{
  "text": "string",
  "name": "string",
  "product_id": 0,
  "agent_id": 0,
  "author": "string",
  "type": "prompt",
  "version_description": "string",
  "document_type": "string",
  "lang": "ru",
  "modality": "text",
  "skip_instructions": "string"
}