API / Getting started
Your first API check
Go from an API key to a document check in a few steps.
1. Create an API key
Open API in your dashboard and create a key. Copy the complete key when it appears; it is only shown once. Store it in a server-side environment variable named ACADEMICX_KEY.
2. Add API balance
Top up in the same dashboard. API checks use a prepaid wallet; a Pro website subscription does not fund API requests.
3. Submit a document
This example contains enough text for an AI check. Each new check spends API balance. Reusing the same Idempotency-Key returns the original check.
curl -X POST https://academi.cx/api/v1/checks \
-H "Authorization: Bearer $ACADEMICX_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: essay-review-001" \
-d '{
"text": "Academic writing develops an argument through careful reading, clear reasoning, and evidence. A useful draft explains how each source contributes to the central question. During revision, writers can check that quotations are marked, citations are complete, and their own analysis remains distinct from the material they discuss. This process makes the argument easier to follow and gives readers a way to evaluate its claims. A strong introduction sets out the problem and explains why it matters. Each paragraph then develops a specific point with relevant examples and a connection to the wider argument. The conclusion brings these points together without introducing unsupported claims. Before submitting a paper, the writer should review its structure, verify source details, and read difficult passages aloud to identify unclear sentences. Feedback from another reader can reveal assumptions that need explanation and help make the final draft more precise.",
"products": [
"ai"
],
"name": "Essay draft",
"metadata": {
"reference": "essay-001"
}
}'
4. Retrieve the result
Creation returns HTTP 202 with a check ID. Save that ID as CHECK_ID, then request the check. Use detail=summary when polling and request the full response after it settles.
| Status | Meaning |
|---|---|
| processing | At least one requested product is still running. |
| complete | Every requested product completed successfully. |
| partial | One product succeeded and another failed. The failed product is refunded. |
| failed | No requested product produced a report. Failed products are refunded. |
curl "https://academi.cx/api/v1/checks/$CHECK_ID?detail=summary" \
-H "Authorization: Bearer $ACADEMICX_KEY"
For combined checks, inspect both product statuses. A partial result still contains the report for the product that succeeded.
Still have a question? We’re here to help.