Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.get-spotlight.com/llms.txt

Use this file to discover all available pages before exploring further.

​
GET /

Returns the API version, your organization ID, and the full list of available endpoint paths. Call this first to confirm your key and base URL are correct.

​
Request

curl -s \
  -H "x-spotlight-api-key: YOUR_API_KEY" \
  "https://app.get-spotlight.com/api/"

​
Response

​
message
string
A friendly label — always "Spotlight Data API".
​
version
string
Current API version string, e.g. "v1".
​
organizationId
string
The organization UUID linked to the API key you sent.
​
endpoints
array
List of all available routes. Each item has:
  • method — HTTP verb (GET, POST, DELETE)
  • path — URL path template
{
  "message": "Spotlight Data API",
  "version": "v1",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "endpoints": [
    { "method": "GET",    "path": "/v1/brands" },
    { "method": "GET",    "path": "/v1/brands/{brandId}/runs" },
    { "method": "GET",    "path": "/v1/brands/{brandId}/last/results" },
    { "method": "GET",    "path": "/v1/runs/{runId}" },
    { "method": "GET",    "path": "/v1/runs/{runId}/content-suggestions" },
    { "method": "GET",    "path": "/v1/runs/{runId}/sources" },
    { "method": "GET",    "path": "/v1/runs/{runId}/perception-sources" },
    { "method": "GET",    "path": "/v1/brands/{brandId}/perception" },
    { "method": "POST",   "path": "/v1/brands/{brandId}/topics-prompts/batch" },
    { "method": "DELETE", "path": "/v1/prompts/{promptId}" }
  ]
}