Quickstart
Run your first Turnitin report request in about 15 minutes.
1. Create an API key
Register an account, open the console, and create an API key for your environment.
2. Upload a document
POST /v1/uploads with multipart form data. The response contains upload_id, which is the only upload reference accepted by later submission calls. PDF, DOCX, and TXT files are accepted up to 50 MB.
3. Freeze a quote and submit idempotently
POST /v1/submissions/quote with upload_id and report_types, then submit the returned quote_id to POST /v1/submissions with the same upload_id, report_types, and a required Idempotency-Key. Reuse the key and identical body when a network retry is needed.
4. Watch and read reports
Poll GET /v1/submissions/:id or subscribe to GET /v1/submissions/:id/events. SSE sends submission_status and job_event records; job_event carries the original event name, occurred_at, and data. GET /v1/submissions/:id/report returns JSON metadata, while /report/file returns the report file bytes. Platform-side terminal failures return the original quota allocation automatically.