citations

Get a citation

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

get/api/v1/citations/{citation}

Request

Base URL: https://pineprompt.com
URL: https://pineprompt.com/api/v1/citations/{citation}
Auth: HTTP bearer

Path parameters

citationinteger required

Example:55821

The numeric ID of the citation.

Query parameters

includestring

Example:source_url

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

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

idinteger

The unique ID of the citation.

response_idinteger

The numeric ID of the response this citation came from. You may pass this ID to the response_id filter on the list endpoint.

source_url_idinteger

The numeric ID of the classified source URL this citation belongs to.

urlstring

The URL that the AI platform cited.

titlestring nullable

The title of the cited page, if known.

descriptionstring nullable

A short description of the cited page, if known.

domainstring nullable

The domain of the source that this citation belongs to.

positioninteger nullable

The one-indexed order in which the citation appeared in the response. A position of 1 means it was the first citation in the answer.

created_atstring date-time

When the citation was recorded.

updated_atstring date-time

When the citation was last updated.

Example response

{
  "id": 55821,
  "response_id": 7842,
  "source_url_id": 3104,
  "url": "https://example.com/blog/comparison",
  "title": "Comparison of AI visibility tools",
  "domain": "example.com",
  "position": 1,
  "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"
  },
  "source_url": {
    "id": 9912,
    "source_id": 4421,
    "url": "https://example.com/article",
    "title": "Comparison of AI visibility tools",
    "source": {
      "id": 4096,
      "project_id": 42,
      "domain": "example.com",
      "type": "blog",
      "playbook": "pitch",
      "analyzed_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"
    },
    "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.