Sign in

v1

latestOpenAPI 3.0.22026-07-174617345.8 KB
Citations

Get the Open Graph data for a citation.

Retrieve the Open Graph data for a citation based on its unique identifier. This endpoint allows you to fetch the Open Graph metadata associated with a specific citation. Here is an example to get citation detail: API SDK.

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

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.",
    "image": "https://www.example.com/image.png"
  }
}