CRSProf

Generate or update CRSProf segments

Async when generation or optimization is requested. Produces an updated CRSProf artifact.

post/api/crsprof/segments

Request

  • Base URL: https://courseprofiler.com
  • URL: https://courseprofiler.com/api/crsprof/segments
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • none

Request body

crsprof_artifact_idstring required
mode'generate'

Response

Async job accepted

request_idstring

Current HTTP request correlation ID, also X-Request-Id; not an idempotency key.

job_persistence'not_persisted' | 'confirmed' | 'unknown'

Latest job metadata write outcome, not a current retrievability guarantee. Do not blindly retry unknown writes.

submission_request_idstring

Original allocation request ID; omitted in legacy job metadata.

job_idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'expired' | 'cancelled' required
status_urlstring required
created_atstring date-time required
started_atstring date-time
completed_atstring date-time
expires_atstring date-time required
progressobject

Example response

{
  "job_id": "job_01JABCDEF",
  "status_url": "/api/jobs/job_01JABCDEF",
  "result_artifacts": [
    {
      "artifact_id": "art_01JABCDEF",
      "content_type": "application/vnd.courseprof+json",
      "warnings": [
        {
          "code": "missing_elevation"
        }
      ]
    }
  ],
  "warnings": [
    {
      "code": "missing_elevation"
    }
  ],
  "errors": [
    {
      "code": "missing_elevation"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.