Lumirank API docs
Prompts

List prompts

GET/v1/prompts

Returns the prompts of your brand, oldest first. By default the list has the active and paused prompts. To see the archived prompts, send status=archived.

The list does not include numbers for each prompt. To get them, call the visibility report with dimensions=prompt.

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

Query Parameters

status?string

The statuses to include, separated by commas: active, paused, archived. The default is active,paused.

limit?integer

The number of rows on each page, from 1 to 200. The default is 50.

Formatint32
offset?integer

The number of rows to skip before this page starts. The default is 0. For the next page, add limit to offset.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/prompts?status=active%2Cpaused&limit=50&offset=0"

prompts

{  "data": [    {      "id": "a41e7c52-3d6b-4f0a-9c8e-1b2d3e4f5a60",      "text": "What is the best CRM for a 5 person sales team?",      "status": "active",      "paused_reason": null,      "countries": [        "US"      ],      "intent": "comparison",      "language": "en",      "created_at": "2026-07-02T10:20:00Z",      "updated_at": "2026-09-14T08:00:00Z"    }  ],  "meta": {    "total": 45,    "limit": 1,    "offset": 0,    "has_more": true  }}

Get your brand GET

Returns the brand that the API key belongs to: its name, domains, countries, engines, prompt counts, and the time of its newest answer. It also names the key that made the request. Use it to check that a key works, and to read the ids that other requests take. `competitor_id` is the id of your own brand in `/v1/mentions` and in the brands report.

Create a prompt POST

Adds a prompt to your brand, the same as **Add prompt** in the dashboard. The new prompt is active, and Lumirank asks it in the brand's next daily run. A prompt counts once for each of its countries toward the prompt limit of your plan. All brands of the organization share this limit. A brand cannot have 2 prompts with the same text, in any status. So if a response is lost and you send the same request again, the prompt is not added twice: the 2nd request gets status `409` with the id of the prompt that the 1st request added.