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.

​
Error response format

All errors return JSON with at minimum a message field: 
{
  "message": "Brand not found",
  "code": "not_found"
}
Some errors include additional context fields (see per-endpoint docs).

​
Status codes

CodeMeaningCommon causes
200OKRequest succeeded.
201CreatedResource was created (write endpoints).
400Bad RequestMissing or invalid request body / parameters.
401UnauthorizedMissing or invalid API key.
403ForbiddenFeature disabled for your plan or organization.
404Not FoundBrand, run, topic, or prompt doesn’t exist — or doesn’t belong to your organization.
405Method Not AllowedHTTP method is not supported on this path.
409ConflictPrompt limit exceeded. Response includes code: "prompt_limit_exceeded" and remaining slot counts.
429Too Many RequestsRate limit exceeded. Back off and retry.
500Internal Server ErrorUnexpected server-side failure. Server logs are tagged [org-api].

​
404 — unknown path

When the path doesn’t match any route, the API returns a helpful 404 with the normalized path and the full list of available endpoints: 
{
  "message": "Endpoint not found",
  "path": "/v1/brandz",
  "availableEndpoints": [
    { "method": "GET", "path": "/v1/brands" },
    { "method": "GET", "path": "/v1/brands/{brandId}/runs" }
  ]
}

​
409 — prompt limit exceeded

{
  "message": "Prompt limit exceeded",
  "code": "prompt_limit_exceeded",
  "remainingSlots": 0,
  "promptLimit": 100,
  "orgWideLimit": 500,
  "orgTotalPrompts": 500
}

​
403 — feature disabled

{
  "message": "Custom perception prompts are not enabled for this organization",
  "code": "custom_perception_prompts_disabled"
}