GET Get a course generation run
Returns the run status, stage, progress, and event feed. When the run is paused for manuscript review, review_url links to the admin dashboard review screen. Pass next_cursor.since and next_cursor.since_id back as since and since_id to read only newer events.
Returns the run status, stage, progress, and event feed. When the run is paused for manuscript review, review_url links to the admin dashboard review screen. Pass next_cursor.since and next_cursor.since_id back as since and since_id to read only newer events.
Send API keys and access tokens as Authorization: Bearer .
In: header
Path Parameters
uuidQuery Parameters
date-timeuuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/course-generations/{id}"{ "data": { "data": null, "meta": { "organization_id": "{organization_id}", "total": 0, "total_count": 0, "limit": 0, "offset": 0, "has_more": true, "requested_at": "2019-08-24T14:15:22Z" } }, "meta": { "organization_id": "{organization_id}", "total": 0, "total_count": 0, "limit": 0, "offset": 0, "has_more": true, "requested_at": "2019-08-24T14:15:22Z" }}{ "error": "string", "code": "string", "message": "string"}{ "error": "string", "code": "string", "message": "string"}{ "error": "string", "code": "string", "message": "string"}{ "error": "string", "code": "string", "message": "string"}GET Search course content GET
Hybrid semantic plus keyword search over course content blocks in the authenticated organization. A row is returned when either engine matches it - a keyword match on the query terms, or a semantic similarity above the relevance floor - and rows are ordered by Reciprocal Rank Fusion of the two engines. The score field is the cosine similarity to the query in [-1, 1], or null when the row was matched by keywords only, and it is not monotonically decreasing because the ordering key is the fusion score rather than the similarity. Content belonging to unpublished or archived courses is never returned. There is no pagination - the response is a single window capped at limit, and meta.total is the number of rows in that window, not a count of matching content in the corpus.
POST Cancel a course generation run POST
Cancels a running or paused run. A canceled run cannot be restarted. Repeating the call reports already_canceled.