Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Personas

List Personas

Personas are the characters that can be used to ask questions about a brand. They are used to get AI answers with citations and mentions.

post/public_api/brand_kits/{brand_kit_id}/personas/list

Path parameters

brand_kit_idinteger required

The Brand Kit ID

Request body

brand_kit_idinteger required

The ID of the Brand Kit

fieldsstring[]

Select additional fields to return.

Optional fields:

  • id: Unique identifier for the persona
  • title: The persona title
  • description: The persona description
  • created_at: When the persona was created
  • updated_at: When the persona was last updated
sort'title' | '-title' | 'created_at' | '-created_at'

Sort field. Prefix with - for descending.

Available sort fields:

  • title/-title: Sort alphabetically by persona title
  • created_at/-created_at: Sort by creation date
pageinteger

Page number

per_pageinteger

Items per page

Response

Successful response