POST · keywords:write

Create keyword

Create a tracked keyword in My brand or a specified keyword group. Existing workspace keyword limits are enforced.

External side effects

REST

POST/api/v1/keywords

curl "https://www.stalkr.ai/api/v1/keywords" \
  --request POST \
  --header "Authorization: Bearer $STALKR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: unique-operation-key"

MCP

Tool name: create_keyword

The MCP tool accepts the same input schema and returns the same structured { data, meta } result as REST.

Input

projectIdrequired

string

groupId

string

Keyword group to assign; defaults to the project's My brand group

valuerequired

string

sourcesrequired

array

aliasesrequired

array

excludedTermsrequired

array

filtersrequired

any

caseSensitiverequired

boolean

idempotencyKey

string

Unique key used to safely retry this write operation

Safe retries

Pass idempotencyKey to the MCP tool or Idempotency-Key to REST when retrying this write.

Authorization

Required scope: keywords:write.

Scope authorization is followed by resource authorization. Project operations check current membership and the minimum role required by the underlying workflow.

Related resources

REST conventions · MCP setup · Errors and limits