get/api/v2/prompts

List prompts with pagination and filters.

List prompts with pagination and filters.

Requires bearer API key

Parameters

X-Project-Id

header

Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.

Schema: string

page

query

No description provided.

Schema: integer

size

query

No description provided.

Schema: integer

query

query

No description provided.

Schema: string

tags

query

Comma-separated values are accepted.

Schema: string

promptTypes

query

Comma-separated values are accepted.

Schema: string

intentTypes

query

Comma-separated values are accepted.

Schema: string

monitorId

query

No description provided.

Schema: string

isActive

query

No description provided.

Schema: string

includeInactive

query

No description provided.

Schema: string

Responses

200

Successful JSON response.

application/json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "prompts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string"
          },
          "monitorId": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "prompt": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ORGANIC",
              "BRAND_SPECIFIC",
              "COMPETITOR_COMPARISON"
            ]
          },
          "intent": {
            "type": "string",
            "enum": [
              "BRANDED",
              "INFORMATIONAL",
              "COMMERCIAL",
              "TRANSACTIONAL",
              "NAVIGATIONAL"
            ]
          },
          "storageType": {
            "type": "string"
          },
          "storageIntent": {
            "type": "string"
          },
          "languageCode": {
            "type": "string",
            "nullable": true
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ]
            }
          },
          "isActive": {
            "type": "boolean"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "monitorId",
          "text",
          "type",
          "intent",
          "isActive"
        ]
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string"
          },
          "monitorId": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "prompt": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "ORGANIC",
              "BRAND_SPECIFIC",
              "COMPETITOR_COMPARISON"
            ]
          },
          "intent": {
            "type": "string",
            "enum": [
              "BRANDED",
              "INFORMATIONAL",
              "COMMERCIAL",
              "TRANSACTIONAL",
              "NAVIGATIONAL"
            ]
          },
          "storageType": {
            "type": "string"
          },
          "storageIntent": {
            "type": "string"
          },
          "languageCode": {
            "type": "string",
            "nullable": true
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ]
            }
          },
          "isActive": {
            "type": "boolean"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "monitorId",
          "text",
          "type",
          "intent",
          "isActive"
        ]
      }
    },
    "total": {
      "type": "integer"
    },
    "page": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "totalPages": {
      "type": "integer"
    }
  },
  "required": [
    "prompts",
    "items",
    "total",
    "page",
    "size",
    "totalPages"
  ]
}

Try it

Send this request to the local WatchLLM REST handler. Use a key from `/workspace/api`; organization keys can include `X-Project-Id` only when the endpoint documents that header.