Skip to main content
POST
Track a new prompt

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Body

application/json
text
string
required

Prompt wording (3 to 500 characters).

Required string length: 3 - 500
persona
enum<string>

Buyer-journey persona; defaults to discoverer.

Available options:
discoverer,
buyer,
evaluator,
competitor,
branded,
control
topic
string | null

Optional topic/theme label.

intent
string | null

Optional buyer intent.

Response

The project already tracked this text; the existing prompt, unchanged.

promptId
string
required
existing
boolean
required

True when the project already tracked this text: that prompt is returned unchanged (its topic, persona, intent and paused state are kept) and the status is 200. False for a new prompt (201).

activeCount
integer
required
Example:

13

cap
integer
required

The effective prompt cap; -1 means unlimited.

Example:

50