SurfacedBySurfacedBy Docs
DocumentationAPIReference

Prompts

List the tracked prompts behind a domain's scans, and pin or unpin your own.

Ask an AI:Open in ChatGPTOpen in Claude

Prompts are the questions SurfacedBy puts to AI platforms on your behalf. The default set is curated automatically from your domain and keywords. Pinned prompts are ones you have explicitly chosen to keep across every scan, so trend charts stay stable even as the rest of the prompt mix rotates.

Listing is available on Professional and Business. Pinning and unpinning are write operations and require a Business key.

GET
/domains/{domain_id}/prompts
/domains/{domain_id}/prompts

Path Parameters

domain_id
Required
Domain Id

Query Parameters

cursorCursor

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/prompts?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null

POST
/domains/{domain_id}/prompts
/domains/{domain_id}/prompts

Request Body

application/jsonRequired

[key: string]any

Path Parameters

domain_id
Required
Domain Id

Header Parameters

X-API-KeyX-Api-Key

Idempotency-KeyIdempotency-Key

curl -X POST "https://example.com/domains/string/prompts" \
  -H "X-API-Key: string" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

Successful Response

null

DELETE
/domains/{domain_id}/prompts/{prompt_id}
/domains/{domain_id}/prompts/{prompt_id}

Path Parameters

domain_id
Required
Domain Id

prompt_id
Required
Prompt Id

Header Parameters

X-API-KeyX-Api-Key

Idempotency-KeyIdempotency-Key

curl -X DELETE "https://example.com/domains/string/prompts/string" \
  -H "X-API-Key: string" \
  -H "Idempotency-Key: string"

Successful Response

null

Previous

Competitors

Next

Reports