responses

Get a response

Returns a single response. The response must belong to the active project.

get/api/v1/responses/{response}

Request

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

Path parameters

responseinteger required
Example:7842

The numeric ID of the response.

Query parameters

includestring
Example:prompt

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

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

idinteger

The unique ID of the response.

prompt_idinteger

The numeric ID of the prompt that produced this response. You may pass this ID to the prompt_id filter on the list endpoint.

monitor_idinteger

The numeric ID of the monitor this response ran under.

prompt_textstring

The exact prompt text the platform was given.

platformstring

The AI platform that produced this answer.

modelstring

The model identifier reported by the platform.

countrystring

The ISO 3166-1 alpha-2 country code the response was run in.

languagestring

The language the response was run in.

contentstring

The raw markdown content the platform produced.

htmlstring

The rendered HTML form of the content, suitable for display.

excerptstring

A whitespace-collapsed plain-text excerpt of the content, suitable for list views.

search_queriesstring[] nullable

The web search queries the platform ran while producing this answer, if any.

created_atstring date-time

When the response was recorded.

updated_atstring date-time

When the response was last updated.

Example response

{
  "id": 7842,
  "prompt_id": 901,
  "monitor_id": 271,
  "prompt_text": "What are the best AI visibility monitoring tools?",
  "platform": "chatgpt",
  "model": "gpt-4",
  "country": "US",
  "language": "en",
  "prompt": {
    "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"
  },
  "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"
  },
  "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"
}

Changes

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