Lumirank API docs
Prompts

Update a prompt

PATCH/v1/prompts/{prompt_id}

Pauses, resumes, archives, or unarchives a prompt, or changes its countries, the same as the prompt actions in the dashboard. Send only the fields you want to change. An empty body changes nothing.

Lumirank does not ask a paused prompt any more, but its past answers stay in reports. Lumirank does not ask an archived prompt either, and its answers are left out of lists and reports. Setting an archived prompt to active unarchives it and starts it again. Resuming a prompt or adding countries can go over the prompt limit of your plan. Then the request gets status 400 and nothing changes.

Authorization

apiKey
AuthorizationBearer <token>

An API key that you create in the Lumirank dashboard, on the Settings > API keys page. Send it in the Authorization header: Bearer lr_....

In: header

Path Parameters

prompt_id*string

The id of the prompt.

Formatuuid

Request Body

application/json

The fields to change.

TypeScript Definitions

Use the request body type in TypeScript.

The fields to change. You cannot change the text or the intent: a new text is a new prompt.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/prompts/a41e7c52-3d6b-4f0a-9c8e-1b2d3e4f5a60" \  -H "Content-Type: application/json" \  -d '{    "status": "paused"  }'

prompt

{  "id": "a41e7c52-3d6b-4f0a-9c8e-1b2d3e4f5a60",  "text": "What is the best CRM for a 5 person sales team?",  "status": "paused",  "paused_reason": "user",  "countries": [    "US"  ],  "intent": "comparison",  "language": "en",  "created_at": "2026-07-02T10:20:00Z",  "updated_at": "2026-10-09T11:05:00Z"}

Get a prompt GET

Returns 1 prompt of your brand, in any status. The id of another brand's prompt gets status `404`, the same as an id that does not exist.

List competitors GET

Returns the brands that AI answers name next to yours, sorted by name. By default the list has the tracked and suggested competitors. To see the dismissed competitors, send `status=dismissed`. Your own brand is not in this list. To read it, call `GET /v1/brand`.