Skip to content
academi.cx

Popular resources

API

Your first API check

Go from an API key to a document check in a few steps.

Help

A check is stuck or failed

Check what is still processing and give support the details needed to investigate.

Help

Plans, payments & cancellations

Find your plan, manage renewal, and get help with a payment.

Learn

Uploading your first document

Take a document from your computer to a readable report. Here is what to expect at each step.

Use Tab to choose a result and Enter to open it.
Sign in
Browse API documentation

API / Files & reports

Download a report

Get a short-lived download URL for an available file associated with an API check.

GET/api/v1/checks/:id/report

Path & query parameters

idstring · pathRequired

The API check ID.

kindstring · queryOptional

"similarity" (default) for the Turnitin PDF, "pdf" for the rendered document, or "original" for the uploaded file.

Available files

AI results are JSON only. Check files.similarity_pdf, files.pdf or files.original before downloading. An unavailable similarity or document PDF returns 409 not_ready; an absent original returns 404 not_found. Download URLs expire after 600 seconds.

Example request · cURL
curl "https://academi.cx/api/v1/checks/$CHECK_ID/report?kind=similarity" \
  -H "Authorization: Bearer $ACADEMICX_KEY"
Example response · 200 · OK
{
  "object": "report",
  "check_id": "9f1c0f52-6a9b-4b1e-9e1a-2d3c4b5a6f70",
  "kind": "similarity",
  "filename": "Essay - Similarity.pdf",
  "url": "https://storage.example/signed-download-url",
  "expires_in": 600
}

Base URL: https://academi.cx/api/v1

← Previous

Create an upload

Next →

Get balance

Still have a question? We’re here to help.