Register an external grader

​

Registers an author-hosted grading endpoint as a Tier 2 external grader. The platform makes a live test call against the URL; only endpoints that return a coercible grading response are accepted. Returns the registered grader's stable id, which content items reference to route grading through the platform proxy.

Body·
required
application/json

Body for registering a new external grader

  • authenticationCredential
    Type: string | null ·
    min length:  
    1
    max length:  
    16384
    write-only
    required

    Credential material sent on every outbound call to the grader. Must be null when authenticationType is none; required (non-empty string) when authenticationType is api_key. Encrypted at rest via KMS; never returned in any response. Wire mapping: api_key → X-Api-Key: <credential>.

  • authenticationType
    Type: string · enum
    required

    How the platform authenticates outbound calls to the grader.

    values
    • none
    • api_key
  • url
    Type: string
    max length:  
    2048    Format: uri
    required

    HTTPS URL of the grading endpoint. Must resolve to a public host.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/content/1.0/external-graders
curl https://platform.dev.timeback.com/content/1.0/external-graders \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "",
  "authenticationType": "none",
  "authenticationCredential": null
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "authenticationType": "none",
  "status": "active",
  "dateCreated": "2026-07-17T08:31:45.116Z",
  "dateLastModified": "2026-07-17T08:31:45.116Z"
}

External grader registered