Skip to main content

API Reference

Caliper provides a comprehensive REST API for programmatic access to the platform.

Authentication​

Caliper supports two authentication methods:

Bearer Token Authentication​

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://caliper.restrat.co.za/api/assignments/

Django Token Authentication​

curl -H 'Authorization: Token YOUR_TOKEN' \
  https://caliper.restrat.co.za/api/assignments/

Core Endpoints​

Assignments​

  • GET /api/assignments/ - List assignments
  • POST /api/assignments/ - Create assignment
  • GET /api/assignments/{id}/ - Get assignment details
  • PATCH /api/assignments/{id}/ - Update assignment

Submissions​

  • GET /api/submissions/ - List submissions
  • POST /api/submissions/ - Submit work
  • GET /api/submissions/{id}/ - Get submission details

Marking​

  • POST /api/ai-mark/ - Trigger AI marking
  • GET /api/submissions/{id}/marking-status/ - Check marking status

PAT Assessments​

  • GET /api/pat-assessments/ - List PAT assessments
  • POST /api/pat-assessments/ - Create PAT assessment
  • POST /api/pat-assessments/{id}/create_phases/ - Create standard phases

For full API documentation, visit the OpenAPI schema.