Create a monitor

Creates a new monitor in the active project. Every monitor binds a set of prompts to one or more AI engines, in a chosen country and language.

POST /api/v1/monitors

A newly created monitor begins running on its next daily run, typically the next morning in the chosen country, once it has at least one active prompt attached. While is_active stays true and the monitor owns at least one active prompt, Pineprompt will continue to run it every day.

A monitor created without any prompts is valid, but it will be skipped on every daily run until you add an active prompt with Create a prompt.
Pineprompt uppercases the country field on write, so the response will always return the value in uppercase form.
Pineprompt does not back-fill historical results. The first daily run happens after the monitor has an active prompt.

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`; sending an unsupported pair will return a `422` response.
country	string	Required	A two-letter ISO 3166-1 alpha-2 country code, such as `US`, `NL`, or `GB`. Pineprompt stores the value uppercased, so you may send `us` as well.
language	string	Required	A two-letter language code, such as `en` or `nl`. The field allows up to 10 characters so that regional variants may be expressed when needed.
is_active	boolean	Required	When set to `true`, the monitor will run on its next daily run. When set to `false`, the monitor is paused and consumes no quota.

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.

curl -X POST https://pineprompt.com/api/v1/monitors \ -H "Authorization: Bearer $PINEPROMPT_TOKEN" \ -H "Pineprompt-Project-Id: 1" \ -H "Content-Type: application/json" \ -d '{ "name": "Brand visibility (US)", "models": [ "chatgpt", "perplexity", "claude" ], "country": "US", "language": "en", "is_active": true }'

import os import requests response = requests.post( "https://pineprompt.com/api/v1/monitors", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", "Content-Type": "application/json", }, json={ "name": "Brand visibility (US)", "models": ["chatgpt", "perplexity", "claude"], "country": "US", "language": "en", "is_active": True, }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->post('https://pineprompt.com/api/v1/monitors', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], 'json' => [ 'name' => 'Brand visibility (US)', 'models' => ['chatgpt', 'perplexity', 'claude'], 'country' => 'US', 'language' => 'en', 'is_active' => true, ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);

{ "id": 271, "project_id": 42, "name": "Brand visibility (US)", "models": [ "chatgpt", "perplexity", "claude" ], "country": "US", "language": "en", "is_active": true, "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }

Body parameters

Allowed values for models

Response

The monitor object

Allowed values for `models`