Lumirank Get a prompt
/v1/prompts/{prompt_id}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.
Authorization
apiKey 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
The id of the prompt.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/prompts/a41e7c52-3d6b-4f0a-9c8e-1b2d3e4f5a60"prompt
{ "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"}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.
Update a prompt PATCH
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.