Purpose
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.
At a high level, this is the canonical way to work with citations resources via the CustomGPT API.
When to use
- When you need to get the open graph data for a citation as part of your backend or automation workflows.
- When rendering citation cards alongside answers and you need richer OpenGraph metadata (title, description, image) for each cited page.
The ability to show the individual page/section of a document where the citation came from is possible for PDF files exclusively, and also only on our Enterprise agreements with a particular deployment type called our PDF viewer, where the PDF cited will open up on the side of the chat interface with the precise page and section of text highlighted where the information came from.
If the Enterprise agreement does not fit your needs, you would likely want to break up the data into more manageable chunks for your users to access.
Can we show sources but not allow downloading?
We also have one option that is available at the time of file upload, under the 'Advanced' tab. You can enable a setting labelled 'Data Retention', and particularly, the option for 'Delete immediately after processing'.
This allows the file to be used for generating an answer, but does not reveal it to your user base for downloading.
