Skip to main content

FullPrompt

prompt objectrequired

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, formatting, playbook and others — see PromptType) and one active version. A playbook is a prompt of type "playbook": an on-demand instruction set the chatbot enables mid-dialogue instead of carrying it in the main prompt.

idIdrequired

Unique numeric identifier of the record.

nameNamerequired

Human-readable prompt name.

description object

Playbooks only: the one-line "when to use" the chatbot sees in its playbook catalog. The model can enable a playbook only if this is set — a playbook without a description is never offered to it. Ignored for other prompt types.

anyOf
string
config object

Per-prompt settings (PromptConfig). Today only playbooks read it: crm_fields_conditions makes the platform enable the playbook automatically for leads whose CRM fields match, before the model runs. Defaults to an empty config.

crm_fields_conditions object

Composite CRM-field conditions (the same shape as on A/B campaigns and outreach: AND/OR with per-field operators). With at least one condition set, the platform enables the playbook in a dialogue as soon as the lead's CRM fields match — before the model runs, without a tool call. An empty conditions list never auto-enables; null (the default) leaves enabling to the model.

anyOf
operatorCRMFieldsConditionsOperator

Possible values: [AND, OR]

Default value: AND
conditions object[]
  • Array [
    • fieldFieldrequired
    operatorCRMFieldConditionOperatorrequired

    Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]

    valueValue
  • ]
    • 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.

    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

    updated_atdate-timerequired

    Last modification time (UTC, ISO 8601).

    author objectrequired

    Who authored the prompt.

    anyOf
    string
    typeTyperequired

    The prompt's purpose/type (see PromptType). "playbook" marks an on-demand instruction set; see description and config.

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

    document_type objectrequired

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

    anyOf
    string
    enabled_version_id objectrequired

    ID of the prompt version currently in use.

    anyOf
    integer
    skip_instructions objectrequired

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

    anyOf
    string
    langLanguagerequired

    Language of the prompt.

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

    modalityModalityrequired

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

    Possible values: [text, voice]

    version objectrequired

    A single saved version of a prompt.

    idIdrequired

    Unique numeric identifier of the record.

    prompt_idPrompt Idrequired

    ID of the prompt this version belongs to.

    version_numberVersion Numberrequired

    Monotonic version number within the prompt.

    contentContentrequired

    The prompt text for this version.

    description objectrequired

    Optional change description for this version.

    anyOf
    string
    author objectrequired

    Who authored this version.

    anyOf
    string
    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

    FullPrompt
    {
      "prompt": {
        "id": 0,
        "name": "string",
        "description": "string",
        "config": {
          "crm_fields_conditions": {
            "operator": "AND",
            "conditions": [
              {
                "field": "string",
                "operator": "EQUALS"
              }
            ]
          }
        },
        "product_id": 0,
        "agent_id": 0,
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "author": "string",
        "type": "prompt",
        "document_type": "string",
        "enabled_version_id": 0,
        "skip_instructions": "string",
        "lang": "ru",
        "modality": "text"
      },
      "version": {
        "id": 0,
        "prompt_id": 0,
        "version_number": 0,
        "content": "string",
        "description": "string",
        "author": "string",
        "created_at": "2024-07-29T15:51:28.071Z"
      }
    }