POpoll-the-people
Citations

Get citation metadata.

Changed on

Returns metadata for a specific citation, including the source document's title, description, URL, and preview information. Use this to display source attribution or allow users to verify the agent's sources.

get/api/v1/projects/{projectId}/citations/{citationId}

Request

Path parameters

projectIdinteger required
Example:1

The unique project identifier.

citationIdinteger required
Example:1

The unique citation identifier.

Response

Get the document metadata data for a citation

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "url": "https://www.example.com",
    "title": "Example Domain",
    "description": "This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission.",
    "summary": "A reserved example domain used for illustration in documentation, which anyone may cite without asking for permission.",
    "image": "https://www.example.com/image.png"
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

  • b80e6dfcf78dRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new Page id is required enum value to the / response property for the response status

    • warning

      added the new Page with id {pageId} not found enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      removed the Project id is required enum value from the / response property for the response status

    • info

      removed the Project with id {projectId} not found enum value from the / response property for the response status