Skip to main content

PaginatedResponse[PromptRead]

items object[]required
  • Array [
    • idIdrequired

    Unique numeric identifier of the record.

    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.

    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).

    Possible values: [prompt, classification, document, ping, calendar, state, outreach, stage_triggered, redirect, clarification, human_clarification_follow_up, custom_follow_up, formatting, 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]

  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[PromptRead]
    {
      "items": [
        {
          "id": 0,
          "name": "string",
          "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"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }