Get Response - Promptwatch API Documentation

Get Response

curl --request GET \
  --url https://server.promptwatch.com/api/v2/responses/{id} \
  --header 'X-API-Key: <api-key>'

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "content": "Northwind Analytics provides enterprise reporting dashboards. For pricing, compare plans on their website — example only, not factual.",
  "model": "gpt-4.1",
  "provider": "openai",
  "visibilityScore": 72.5,
  "sentimentScore": 0.33,
  "sentiment": "POSITIVE",
  "toneOfVoice": "professional",
  "mentionedOurBrand": true,
  "competitorMentions": [
    "Contoso Insights"
  ],
  "citationCount": 2,
  "prompt": {
    "id": "6ba7b814-9dad-11d1-80b4-00c04fd430c8",
    "prompt": "Best analytics tools for mid-market teams?",
    "type": "ORGANIC",
    "intent": "COMMERCIAL",
    "llmMonitor": {
      "id": "6ba7b815-9dad-11d1-80b4-00c04fd430c8",
      "name": "US English monitor"
    }
  },
  "brandMentions": [
    {
      "brandName": "Northwind Analytics",
      "brandDomain": "northwind.example.com",
      "relation": "SELF",
      "visibilityScore": 85,
      "position": 1,
      "sentiment": "POSITIVE",
      "toneOfVoice": "professional"
    }
  ],
  "citations": [
    {
      "url": "https://docs.example.com/pricing",
      "domain": "docs.example.com",
      "rank": 1,
      "title": "Pricing overview",
      "sourceType": "CORPORATE",
      "contentType": "PRODUCT_PAGE"
    },
    {
      "url": "https://blog.example.com/compare",
      "domain": "blog.example.com",
      "rank": 2,
      "title": "Tool comparison (illustrative)",
      "sourceType": "BLOG",
      "contentType": "COMPARISON"
    }
  ],
  "createdAt": "2026-03-29T14:22:00.000Z"
}

GET

/

responses

/

{id}

Get Response

curl --request GET \
  --url https://server.promptwatch.com/api/v2/responses/{id} \
  --header 'X-API-Key: <api-key>'

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "content": "Northwind Analytics provides enterprise reporting dashboards. For pricing, compare plans on their website — example only, not factual.",
  "model": "gpt-4.1",
  "provider": "openai",
  "visibilityScore": 72.5,
  "sentimentScore": 0.33,
  "sentiment": "POSITIVE",
  "toneOfVoice": "professional",
  "mentionedOurBrand": true,
  "competitorMentions": [
    "Contoso Insights"
  ],
  "citationCount": 2,
  "prompt": {
    "id": "6ba7b814-9dad-11d1-80b4-00c04fd430c8",
    "prompt": "Best analytics tools for mid-market teams?",
    "type": "ORGANIC",
    "intent": "COMMERCIAL",
    "llmMonitor": {
      "id": "6ba7b815-9dad-11d1-80b4-00c04fd430c8",
      "name": "US English monitor"
    }
  },
  "brandMentions": [
    {
      "brandName": "Northwind Analytics",
      "brandDomain": "northwind.example.com",
      "relation": "SELF",
      "visibilityScore": 85,
      "position": 1,
      "sentiment": "POSITIVE",
      "toneOfVoice": "professional"
    }
  ],
  "citations": [
    {
      "url": "https://docs.example.com/pricing",
      "domain": "docs.example.com",
      "rank": 1,
      "title": "Pricing overview",
      "sourceType": "CORPORATE",
      "contentType": "PRODUCT_PAGE"
    },
    {
      "url": "https://blog.example.com/compare",
      "domain": "blog.example.com",
      "rank": 2,
      "title": "Tool comparison (illustrative)",
      "sourceType": "BLOG",
      "contentType": "COMPARISON"
    }
  ],
  "createdAt": "2026-03-29T14:22:00.000Z"
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

id

string<uuid>

required

Response ID

Response

Default Response

id

string<uuid>

required

LLM response identifier

content

string

required

The LLM response content

model

string

required

Model used for this response

provider

string

required

LLM provider

mentionedOurBrand

boolean

required

Whether the project's brand was mentioned

competitorMentions

string[]

required

List of competitor brands mentioned

citationCount

number

required

Total number of citations in response

brandMentions

object[]

required

Brands detected in this response with per-brand metrics

Show child attributes

prompt

object

required

Show child attributes

citations

object[]

required

Full list of citations in the response

Show child attributes

createdAt

string<date-time>

required

Response creation timestamp

visibilityScore

number | null

Visibility score for this response

sentimentScore

number | null

Sentiment score for this response

sentiment

enum<string> | null

Sentiment classification

Available options:

POSITIVE,

NEGATIVE,

NEUTRAL

toneOfVoice

string | null

Detected tone of voice

List Responses Response Summary

⌘I