Skip to main content
POST
Create a persona

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, prompt suggestions, and prompt analysis results
  • prompts:write: Create, update, archive prompts and generate, edit, or review prompt suggestions
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • analytics:write: Write events to analytics
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

productId
string
Minimum string length: 1
brandId
string
Minimum string length: 1

Body

application/json
name
string
required
Required string length: 1 - 200
description
string
required
Required string length: 1 - 4000
systemPrompt
string | null
Maximum string length: 20000

Response

A persona with this name already existed and is returned unchanged

ok
enum<boolean>
required
Available options:
true
data
any