curl --request GET \
--url https://api.linqalpha.com/v1/references \
--header 'X-API-KEY: <api-key>'{
"references": [
{
"id": "12",
"citation_idx": "12",
"search_type": "rms",
"chunk_id": "123e4567-e89b-12d3-a456-426614174000",
"text": "For fiscal year 2024, Tesla expects EBIT to grow between 15% and 20%...",
"text_type": "paragraph",
"document_id": "123e4567-e89b-12d3-a456-426614174000",
"document_name": "Tesla 10-K 2023",
"s3_file_key": "tesla/filings/2023/10k.pdf",
"external_url": "https://www.sec.gov/ix?doc=/Archives/edgar/data/1318605/000095017024002308/tsla-20231231.htm",
"metadata": {
"source": "filing",
"ticker": "TSLA",
"published_at": "2024-02-14"
},
"custom_metadata": null
}
]
}References
Retrieves evidence references for a specific chat message. Each reference corresponds to an exact chunk used in the final answer generated by the LinqAlpha engine. These chunks represent the precise portions of documents (e.g., filings, transcripts, or news) that were retrieved and cited by the model to construct the final response..
How to find chat_message_id:
Look for the event with event_name set to search_results in the Chat API response data. For detailed instructions, see search_results event response.
How to view original documents:
- Via Viewer:
https://chat.linqalpha.com/rms/viewer?chat_message_id={chat_message_id}&citation_idx={citation_idx} - Direct Download: If the reference contains a
document_id, you can access the original document directly through the presigned_url endpoint.
curl --request GET \
--url https://api.linqalpha.com/v1/references \
--header 'X-API-KEY: <api-key>'{
"references": [
{
"id": "12",
"citation_idx": "12",
"search_type": "rms",
"chunk_id": "123e4567-e89b-12d3-a456-426614174000",
"text": "For fiscal year 2024, Tesla expects EBIT to grow between 15% and 20%...",
"text_type": "paragraph",
"document_id": "123e4567-e89b-12d3-a456-426614174000",
"document_name": "Tesla 10-K 2023",
"s3_file_key": "tesla/filings/2023/10k.pdf",
"external_url": "https://www.sec.gov/ix?doc=/Archives/edgar/data/1318605/000095017024002308/tsla-20231231.htm",
"metadata": {
"source": "filing",
"ticker": "TSLA",
"published_at": "2024-02-14"
},
"custom_metadata": null
}
]
}Authorizations
Query Parameters
Chat message ID
Response
References response
References
Show child attributes
Show child attributes
Reference citation index (will be deprecated in the future)
"123e4567-e89b-12d3-a456-426614174000"
Reference citation index
"123e4567-e89b-12d3-a456-426614174000"
Type of search used
rms, external "rms"
ID of the chunk this reference belongs to
Exact text content of the matching chunk retrieved during search and used in the final answer. This is the precise segment of the source document that the model cited as evidence.
Type of text content
paragraph, table, image, news Human-readable document name
External S3 URL to access the document
Additional metadata information
Show child attributes
Show child attributes
"news"
emailnotes, generalnotes, templatednotes, custom-data, structured-data note, attachment Show child attributes
Show child attributes
internal, brokerage, expert_network, corporate_data, external, earnings_call, filing calls, model, analysis, report, filings, ir_slide, factsheet, email, earning, slides, 10-K, 10-Q, 6-K, 8-K, DEF 14A, 20-F, annual_results, interim_results, annual_report, interim_report, offerings, others Basic Materials, Consumer Cyclicals, Consumer Staples, Energy, Financial Services, Healthcare, Industrials, Technology, Transportation, Telecom Services, Utilities Agriculture, Chemicals, Metals & Mining, Paper & Forest, Steel, Automobiles, Branded Consumer Goods, Business Services, Consumer Cyclicals, Consumer Durables, Education, Entertainment & Leisure, Gaming, Housing, Lodging, Media, Restaurants & Pubs, Retail, Textile, Apparel & Footwear, Travel, Beverages, Consumer Products, Food, Tobacco, Clean Energy, Energy, Gas, Oil, Oil Services, Banks, Brokers & Asset Managers, Capital Markets, Diversified Financials, Insurance, Real Estate, Specialty Finance, Biotechnology, Healthcare Services, Life Sciences, Medical Technology, Pharmaceuticals, Aerospace & Defense, Capital Goods, Construction, Electrical Equipment, Environmental Services, Machinery, Machinery & Diversified Industrials, Multi-Industry, Packaging, Communications Technology, Hardware, Info Services, Integrated Electricals, Internet, IT Services, IT Supply Chain, Semiconductors, Software, Technology, Air Freight, Airlines, Airports, Infrastructure, Logistics, Railroads, Shipping, Trucking, Communication Services, Satellite, Telecom Wireless, Towers, Diversified, MLPs, Power, Utilities, Water Document ID that this reference points to
S3 file path for the document
User-defined metadata. This field may contain additional structured data based on the document type and user configuration.
Show child attributes
Show child attributes
SEC EDGAR filing metadata. This field is only available for SEC filing documents and is provided upon request. Not all users will have access to this data. Contact [email protected] to enable EDGAR metadata for your organization.
Show child attributes
Show child attributes
Public EDGAR URL to the source filing document on the SEC website
"https://www.sec.gov/Archives/edgar/data/1045810/000104581023000227/nvda-20231029.htm"
SEC accession number uniquely identifying the filing. Format: XXXXXXXXXX-XX-XXXXXX
"0001045810-23-000227"
Additional SEC filing identifiers
Was this page helpful?