Skip to main content
POST
Assess a typed-in keyword

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json
keyword
string
required
Required string length: 1 - 191
draftId
string

The draft_… id. Optional on every onboarding route: defaults to the onboarding's current draft.

Required string length: 1 - 64
Example:

"draft_k3v9x0q2m1"

tag
enum<string>

Classification of what this keyword represents. Used to route posts to brand / competitor / industry-context workflows and pick the right AI prompt.

Available options:
own_brand,
competitor,
industry_term
Example:

"own_brand"

keywords
object[]

The step's current rows, so the assessment knows what is already a brand or a competitor.

Maximum array length: 20

Response

200 response

keyword
string
required
tag
enum<string>
required

Classification of what this keyword represents. Used to route posts to brand / competitor / industry-context workflows and pick the right AI prompt.

Available options:
own_brand,
competitor,
industry_term
Example:

"own_brand"

tagSource
enum<string>
required
Available options:
given,
agent,
fallback
refined
boolean
required
band
enum<string>
required

How busy the keyword reads from a sample of recent posts: quiet · standard · busy (a platform hit its cap before its window ran out) · very_busy (its cap filled within a day).

Available options:
quiet,
standard,
busy,
very_busy
summary
string | null
required
settings
string[]
required
additionalTerms
string[]
required
excludeWords
string[]
required
refusal
string | null
required