Skip to main content
POST
Create Suggestion

Authorizations

api_key
string
header
required

Body

application/json
changeType
enum<string>
required

'add' proposes a brand new entity; 'refine' proposes changes to an existing one.

Available options:
add,
refine
Example:

"add"

entityType
enum<string>
required

Library entity type: persona, product, segment, use_case, competitor, alternative, buying_trigger, objection, proof_point, reference, service, solution, brand_voice.

Available options:
persona,
product,
segment,
use_case,
competitor,
alternative,
buying_trigger,
core_feature,
objection,
proof_point,
reference,
service,
solution,
brand_voice
Example:

"persona"

instructions
string
required

Detailed natural-language description of what to add or change, and why.

name
string

Name of the new entity. Required when changeType is 'add'.

oId
string

oId of the entity to refine (from the entity list endpoints). Required when changeType is 'refine'.

keyContext
string

Additional background text to inform the proposal.

sources
object[]

Optional source materials (URLs to fetch, or raw text) to inform the proposal.

Response

The queued pending suggestion

_metadata
object
required
data
object
required