post · monitors:write
Add a keyword
Add a keyword
Write
REST
post
/api/v1/keywordscurl "https://herculeradar.com/api/v1/keywords" \
--request POST \
--header "Authorization: Bearer hr_live_…" \
--header "Content-Type: application/json" \
--header "Idempotency-Key: $(uuidgen)" \
--data '{"keyword":"Acme"}'MCP
Tool name create_keyword. It takes the same input and returns the same { data, meta } envelope as REST, because both call the same function.
Add a term to an existing monitor, or start a new monitor if monitor_id is omitted. Mentions already collected stay.
Request body
{
"type": "object",
"required": [
"keyword"
],
"properties": {
"keyword": {
"type": "string"
},
"monitor_id": {
"type": "string"
},
"group_id": {
"type": "string"
}
}
}Response
{
"data": {
"id": "uuid",
"keywords": [
"Acme"
]
},
"meta": {
"capability": "create_keyword",
"requestId": "req_9f2b4a8c1d0e",
"idempotencyReplayed": false,
"docs": "https://herculeradar.com/docs/reference/create_keyword"
}
}Authorization
Requires the monitors:write scope. A credential without it gets 403 FORBIDDEN. Resources in projects the credential cannot reach answer 404 NOT_FOUND rather than 403, so ids cannot be probed across tenants.
Send an Idempotency-Key header. A completed response is replayed for 24 hours, so a retry after a timeout cannot create a duplicate.