---
title: "POST /api/v1/monitors/keywords"
method: POST
path: "/api/v1/monitors/keywords"
tags: ["Monitors"]
---

# POST /api/v1/monitors/keywords

`POST /api/v1/monitors/keywords`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/monitors/keywords`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Creates a keyword monitor, with no count limit. Active monitors check every second for 30 credits an hour, events & webhook deliveries included. That hourly price is a monitor's only charge. Creation needs the credits of the first hour.

## Request body

- object
  - `query` string, required: X search query to monitor. Xquik normalizes whitespace.
  - `name` string: Your own label for the keyword monitor. Its events carry it as monitorName.
  - `eventTypes` EventType[], required: Array of event types to subscribe to.

## Response `201`

Keyword monitor created

- KeywordMonitor: Keyword monitor that tracks matching public X activity.
  - `id` string, required
  - `query` string, required
  - `name` string: Customer-set label of the keyword monitor, when set.
  - `eventTypes` EventType[], required: Array of event types to subscribe to.
  - `isActive` boolean, required
  - `createdAt` string, date-time, required
  - `nextBillingAt` string, date-time, required: Next hourly credit charge time for this keyword query monitor.
  - `pausedReason` 'insufficient_credits': Why Xquik paused this keyword monitor. The balance could not pay an hour, so add credits & resume. Absent when the monitor is active or you paused it yourself.
  - `pausedAt` string, date-time: When Xquik paused this keyword monitor.

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `402`: Payment required. MPP reads include `WWW-Authenticate`. Authenticated reads include balances, plus checkout when the key can open it. A key that reads only gets the account page instead. A failed request never creates checkout. A caller on a plan gets top-up only, plus `credits_renew_at` when the plan renews. Guest keys offer top-up.
- `409`: Keyword monitor already exists
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 14 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …10 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/monitors/keywords/post.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xquik-dev/apis/xquik-api/revisions/45942c75fdc2?raw)