Platform Authentication
Provide your API Key to enable the interactive playground across all platform tools.
Correctness Check
Developer portal for managing document correctness evaluation jobs.
API Reference
Submit a PDF document to create a new correctness evaluation job. The job is created asynchronously — use the Check Results endpoint to poll for completion.
POST https://cspaper-frontend-prod.azurewebsites.net/api/platform/correctness-check
Authentication
| Header | Required | Description |
|---|---|---|
| X-API-Key | Yes | Your organisation's API key (csp_live_...). Determines the owning organisation of the job. |
Request Body — multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
| file | File (PDF) | Yes | The PDF document to evaluate. The filename is stored alongside the job record. |
Response — 202 Accepted
{
"status": 200,
"data": {
"job_id": "<string> // Unique job identifier — save this to poll for results",
"status": "PENDING // Initial status; transitions to COMPLETED when done"
}
}
Error Responses
| Status | Cause |
|---|---|
| 401 Unauthorized | Missing or invalid X-API-Key header. |
| 422 Unprocessable Entity | No file field included in the request body. |
Example (cURL)
curl -X POST \
https://cspaper-frontend-prod.azurewebsites.net/api/platform/correctness-check \
-H "X-API-Key: YOUR_API_KEY" \
-F "file=@paper.pdf"
Interactive Playground
Configure your API Key in the platform header to use the playground.
Execution Result
Waiting for configuration...