Skip to main content

Reference Quality Check API

This guide helps you easily integrate the Trinka Reference Quality Report API into your applications to upload academic documents and receive a structured JSON output that contains the results of checks performed on the references within the document.

Use Cases

Here are some of the things that the Reference Quality Report API can do for you:

  • Checking the quality of references
  • Identifying problematic references
  • Verifying reference details against external databases.

How to Get Started

Get an API key:​

You need an API key to get started. This API key is a unique identifier used to authenticate requests associated with your account for usage and billing purposes. Your API key must be included in each request. You can generate your API key by signing up on the Trinka developer portal (https://developer.trinka.ai/).

Send an API request:​

The Trinka AI Content Detector API uses RESTful architecture, and all input and output data are in JSON format. Standard HTTP response codes and authentication are used. The content-type of both request and response must be application/json. All data must be UTF-8 encoded.

Get the results:​

Once the file processing is complete and the file_status is SUCCESS, the "Fetch Report" endpoint will provide a structured JSON output. This output contains the results of all reference checks performed on the references extracted from your document. The report includes a quality_summary object with an overview of metrics (e.g., Journal_overuse, old_references, retracted_references, unverified_references, good_references) and a quality_report array with detailed metrics for each individual reference.

Handle errors:​

Trinka uses standard codes to indicate success or problems. Refer to the appendix for more details.

API Request-Response​

The Trinka Reference Quality Report API helps you analyze and improve the quality of references in academic documents by identifying issues like outdated, retracted, or poorly cited references. It provides detailed reports to ensure the credibility of your references. Contact us at support@trinka.ai for more information or to get started with the API.