Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.

Scopes

keywords:generate

Run keyword research and keyword generation runs. Spends the site's AI credits.

Headers

Idempotency-Key
string
required

Opaque client command key of 1 to 128 visible ASCII characters. UUID recommended; reuse only for the same command.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Path Parameters

profile_id
string<uuid>
required

Profile UUID; must be in the grant allowlist and currently accessible to the actor.

Body

application/json

Options of the application's keyword generation; all are optional.

kd_preset
enum<string>

Keyword difficulty preset; defaults to medium.

Available options:
all,
easy,
medium,
hard
keyword
string

Source keyword replacing the site's main keyword for this run

Minimum string length: 2
instructions
string

Optional guidance on the keywords to look for.

Maximum string length: 2000
mode
enum<string>

complete (default) adds keywords to the library; fresh first moves the available keywords to the removed list, then runs a full search.

Available options:
complete,
fresh

Response

Keyword generation run accepted; follow it with getKeywordRun.

data
object
required
meta
object
required