Skip to main content
GET
/
course
/
getCourse
/
{courseID}
Get course
curl --request GET \
  --url https://api.example.com/course/getCourse/{courseID}
{
  "_id": "<string>",
  "name": "<string>",
  "instructions": "<string>",
  "color": "<string>",
  "placeholder": "<string>",
  "backgroundImg": "<string>",
  "openAIAssistantID": "<string>",
  "openAIFiles": [
    "<string>"
  ],
  "transcriptions": [
    "<string>"
  ],
  "sourceFiles": [
    "<string>"
  ],
  "openAIKey": "<string>"
}
Returns a single course by ID. This is a public endpoint — no authentication is required.
This is the endpoint used by the embeddable chatbot widget to load course configuration (name, color, placeholder text, background image, and instructions) before rendering.

​
Path parameters

​
courseID
string
required
The ID of the course to retrieve.

​
Response

​
200 — Success

Returns the course object directly (not wrapped in a key).
​
_id
string
Unique identifier for the course.
​
name
string
The course display name.
​
instructions
string
The AI system prompt used by the course chatbot.
​
color
string
The chatbot accent color as a hex string. Defaults to "#fecc4e".
​
placeholder
string
The input field hint text shown in the chatbot UI. Defaults to "What is significant about horseshoe crabs".
​
backgroundImg
string
URL of the chatbot background image.
​
openAIAssistantID
string
The OpenAI assistant ID for this course.
​
openAIFiles
string[]
IDs of files uploaded to OpenAI for retrieval.
​
transcriptions
string[]
Array of Transcription document IDs for the course’s processed videos.
​
sourceFiles
string[]
Array of Source document IDs (MongoDB ObjectIds) for the processed YouTube videos.
​
openAIKey
string
Custom OpenAI API key for this course, if set. Empty string if using the platform default.

​
Example

curl --request GET \
  --url http://localhost:8000/course/getCourse/64f1a2b3c4d5e6f7a8b9c0d1
200
{
  "_id": "64f1a2b3c4d5e6f7a8b9c0d1",
  "name": "Introduction to Marine Biology",
  "instructions": "You are a helpful AI assistant for a University classroom that answers questions for students about this course",
  "color": "#fecc4e",
  "placeholder": "What is significant about horseshoe crabs",
  "backgroundImg": "https://res.cloudinary.com/dlk3ezbal/image/upload/v1699589098/jqmlca7vhr0cnzgdbaah.png",
  "openAIAssistantID": "asst_abc123xyz",
  "openAIFiles": ["file-abc123"],
  "transcriptions": ["64f1a2b3c4d5e6f7a8b9c0d2"],
  "sourceFiles": [],
  "openAIKey": ""
}

Build docs developers (and LLMs) love

Get started for freeTalk to us