prompts

Create a prompt

Creates a new prompt under a monitor in the active project.

post/api/v1/prompts

Request

  • Base URL: https://pineprompt.com
  • URL: https://pineprompt.com/api/v1/prompts
  • Auth: HTTP bearer

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Request body

monitor_idinteger required

The numeric ID of the monitor that will own the new prompt. The monitor must belong to the active project.

promptstring required

The question the monitor will ask each platform on every run. May be up to <strong>2000</strong> characters.

is_activeboolean required

When set to true, the prompt will run on every daily run. When set to false, the prompt is skipped.

Example request

{
  "monitor_id": 271,
  "prompt": "What are the best AI visibility monitoring tools?",
  "is_active": true
}

Response

Created

idinteger

The unique ID of the prompt.

monitor_idinteger

The ID of the monitor that owns this prompt.

promptstring

The question text the monitor asks each platform on every run.

is_activeboolean

Whether the prompt will run on each daily run of its monitor.

created_atstring date-time

When the prompt was created.

updated_atstring date-time

When the prompt was last updated.

Example response

{
  "id": 901,
  "monitor_id": 271,
  "prompt": "What are the best AI visibility monitoring tools?",
  "is_active": true,
  "monitor": {
    "id": 271,
    "project_id": 42,
    "name": "Brand visibility (US)",
    "platforms": [
      "chatgpt",
      "perplexity",
      "claude"
    ],
    "country": "US",
    "language": "en",
    "is_active": true,
    "project": {
      "id": 42,
      "organization_id": 7,
      "name": "Acme Marketing",
      "brand_id": 555,
      "organization": {
        "id": 7,
        "name": "Acme Inc.",
        "created_at": "2026-05-15T09:11:42+00:00",
        "updated_at": "2026-05-15T09:11:42+00:00"
      },
      "created_at": "2026-05-15T09:11:42+00:00",
      "updated_at": "2026-05-15T09:11:42+00:00"
    },
    "created_at": "2026-05-15T09:11:42+00:00",
    "updated_at": "2026-05-15T09:11:42+00:00"
  },
  "created_at": "2026-05-15T09:11:42+00:00",
  "updated_at": "2026-05-15T09:11:42+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.