USusesapient
Prompts

Retrieve Prompt

Changed on

Returns a prompt, including its topic, platforms, tags, and lifecycle status.

get/v1/prompts/{prompt_id}

Request

  • Base URL
    https://api.lightsage.com
  • Auth
    API key in header X-Lightsage-Api-Key

Path parameters

prompt_idstring required

Response

Successful Response

idstring required
topic_idstring required
textstring required
is_brandedboolean

Whether the prompt text names your own brand. Detected when the prompt is created, and can be set explicitly.

language_idstring nullable
region_idstring nullable
status'active' | 'inactive' | 'archived' required

The prompt lifecycle status. Only active prompts run on schedule.

created_atstring nullable
updated_atstring nullable

Changes