Monitors
Update a monitor
Replaces every field on a monitor. Since this endpoint uses PUT semantics, every field is required on update.
/api/v1/monitors/{monitor}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| monitor | integer | Required | The numeric ID of the monitor. |
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Required | A human-readable name for the monitor. May be up to 120 characters. |
| models | string[] | Required | The AI engines you would like the monitor to run against. Each engine must support the chosen |
| country | string | Required | A two-letter ISO 3166-1 alpha-2 country code. Pineprompt stores the value uppercased. |
| language | string | Required | A two-letter language code, such as |
| is_active | boolean | Required | When set to |
Allowed values for models
| Field | Type | Description |
|---|---|---|
| chatgpt | string | |
| perplexity | string | |
| gemini | string | |
| grok | string | |
| copilot | string | |
| claude | string | |
| google_ai_mode | string | |
| google_ai_overview | string |
Response
The monitor object
| Field | Type | Description |
|---|---|---|
| id | integer | The unique ID of the monitor. |
| project_id | integer | The ID of the project this monitor runs under. |
| name | string | The display name of the monitor. |
| models | string[] | The AI engines the monitor runs against. |
| country | string | The ISO 3166-1 alpha-2 country code. |
| language | string | The language the monitor runs in. |
| is_active | boolean | Whether the monitor will run on its next daily run. |
| created_at | datetime | When the monitor was created. |
| updated_at | datetime | When the monitor was last updated. |