Skip to main content
GET
/
prompts
List Prompts
curl --request GET \
  --url https://server.promptwatch.com/api/v1/prompts \
  --header 'X-API-Key: <api-key>'
{
  "prompts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "type": "ORGANIC",
      "isActive": true,
      "languageCode": "<string>",
      "llmMonitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "llmMonitor": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "amountOfResponses": 123,
      "volume": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "intent": "BRANDED",
      "averageVisibility": 123,
      "difficulty": 123
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123,
  "totalPages": 123
}

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
size
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
llmMonitorId
string<uuid>

Filter by specific monitor ID

query
string

Search query for prompt text (full-text search)

isActive
boolean

Filter by active/inactive status

types
enum<string>[]

Filter by prompt types

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
updatedAt,
isActive,
type,
intent
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Default Response

prompts
object[]
required

Array of prompts

total
number
required

Total number of prompts matching the query

page
number
required

Current page number

size
number
required

Number of items per page

totalPages
number
required

Total number of pages