Skip to main content
GET
/
responses
/
{id}
Get Response
curl --request GET \
  --url https://server.promptwatch.com/api/v2/responses/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "model": "<string>",
  "provider": "<string>",
  "mentionedOurBrand": true,
  "competitorMentions": [
    "<string>"
  ],
  "citationCount": 123,
  "prompt": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompt": "<string>",
    "type": "ORGANIC",
    "llmMonitor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "intent": "BRANDED"
  },
  "citations": [
    {
      "url": "<string>",
      "domain": "<string>",
      "rank": 123,
      "title": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "visibilityScore": 123,
  "sentimentScore": 123,
  "sentiment": "POSITIVE",
  "toneOfVoice": "<string>"
}

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

Response unique 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

prompt
object
required
citations
object[]
required

Full list of citations in the response

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