Skip to main content
v1.0GuidesGuidesAPI ReferenceAPI Reference

Prompts

GET 
/resource/ai/prompts
GEThttps://api2.sonalabs.com/resource/ai/prompts

Retrieve a paginated list of AI prompts for a specific brand, with optional filtering by brand domain.

This endpoint returns prompts associated with an organization. Each prompt includes the prompt text, status, topic, and brand information. You can optionally filter by brand domain to find specific prompts.

Each prompt also carries its AI Visibility metrics, calculated over the AI answers (rankings) between startDate and endDate, or over all answers when no range is given:

  • visibility: % of the prompt's answers that mention your brand.
  • position: the prompt's highest ranking position value for your brand (0 = never mentioned).
  • shareOfVoice: your brand's share of all brand mentions in the prompt's answers, in %.
  • lastRankedAt: when the prompt was last run.

status is 1 (active), 0 (archived) or 2 (suggested). parentId is set on fan-out prompts generated from another prompt.

Results are sorted by id unless orderBy is given, and are paginated. Use the offset and limit parameters to page through the full result set; the response includes the total count along with the offset and limit applied to the current page.

Calling this endpoint does not consume credits.

Request​

Responses​

Success