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
mode
enum<string>
required

suggestions: expansions of each seed; related: semantically related keywords of each seed; ideas: keyword ideas for all seeds together.

Available options:
suggestions,
related,
ideas
seeds
string[]
required

Seed keywords; duplicates are ignored.

Required array length: 1 - 5 elements
Required string length: 2 - 80
max_results
integer

Maximum number of keywords returned; defaults to the largest result set of one research call

Required range: x >= 1

Response

Researched keywords with their metrics, the AI credits spent and the durable receipt.

data
object
required
Example:
meta
object
required