prompts

Get a prompt

Returns a single prompt. The prompt must belong to a monitor inside the active project.

get/api/v1/prompts/{prompt}

Request

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

Path parameters

promptinteger required
Example:901

The numeric ID of the prompt.

Query parameters

includestring
Example:monitor

A comma-separated list of related resources to include in the response. Allowed values: monitor, monitor.project, monitor.project.organization.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

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.