Prompts

List Prompts

post

Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
brand_kit_idintegerRequired

The Brand Kit ID

Body
brand_kit_idintegerRequired

The ID of the Brand Kit

start_datestringOptional

Start date for metrics (ISO 8601). Defaults to 1 month ago.

end_datestringOptional

End date for metrics (ISO 8601). Defaults to today.

personasinteger[]Optional

Filter metrics by persona IDs

sortstring · enumOptional

Sort field. Prefix with - for descending.

Available sort fields:

  • text/-text: Sort alphabetically by prompt text
  • created_at/-created_at: Sort by creation date
  • prompt_volume/-prompt_volume: Sort by prompt volume level
  • mention_rate/-mention_rate: Sort by mention rate
  • citation_rate/-citation_rate: Sort by citation rate
Possible values:
pageintegerOptional

Page number

Default: 1
per_pageinteger · max: 100Optional

Items per page

Default: 25
Responses
chevron-right
200

Successful response

application/json
post
/public_api/brand_kits/{brand_kit_id}/prompts/list

Get Prompt

get

Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
brand_kit_idintegerRequired

The Brand Kit ID

idintegerRequired

The resource ID

Responses
chevron-right
200

Successful response

application/json
get
/public_api/brand_kits/{brand_kit_id}/prompts/{id}

Last updated

Was this helpful?