Skip to main content
POST
/
prompts
Create Prompt
curl --request POST \
  --url https://server.promptwatch.com/api/v2/prompts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "llmMonitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "ORGANIC",
  "languageCode": "en-US",
  "keywords": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "isActive": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt": "<string>",
  "type": "<string>",
  "isActive": true,
  "llmMonitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "intent": "<string>",
  "languageCode": "<string>"
}

Authorizations

X-API-Key
string
header
required

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

Body

application/json
prompt
string
required

The prompt text

Minimum string length: 1
llmMonitorId
string<uuid>
required

Monitor to attach prompt to

type
enum<string>
required

Type of prompt

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
languageCode
string
default:en-US

Language code

keywords
string[]

Optional keywords

tags
string[]

Optional tag names

isActive
boolean
default:true

Whether prompt is active

Response

Default Response

id
string<uuid>
required
prompt
string
required
type
string
required
isActive
boolean
required
llmMonitorId
string<uuid>
required
createdAt
string<date-time>
required
intent
string | null
languageCode
string