Get all courses

Retrieve all courses belonging to the authenticated user.

GET /course/getAllCourses

Get all courses

cURL

curl --request GET \
  --url https://api.example.com/course/getAllCourses \
  --header 'x-access'\''courser-auth-token: <x-access'\''courser-auth-token>'

200

{
  "courses": [
    {
      "_id": "<string>",
      "name": "<string>",
      "instructions": "<string>",
      "color": "<string>",
      "placeholder": "<string>",
      "backgroundImg": "<string>",
      "openAIAssistantID": "<string>",
      "openAIFiles": [
        "<string>"
      ],
      "transcriptions": [
        "<string>"
      ],
      "sourceFiles": [
        "<string>"
      ],
      "openAIKey": "<string>"
    }
  ]
}

Returns an array of all courses owned by the currently authenticated user. Authentication is required.

Request headers

x-access'courser-auth-token · string · required

Your JWT authentication token.

Response

200 — Success

courses · object[] · required

An array of course objects owned by the authenticated user.

Show Course properties

_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.

placeholder · string

The input field hint text shown in the chatbot UI.

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.

Example

cURL

curl --request GET \
  --url http://localhost:8000/course/getAllCourses \
  --header "x-access'courser-auth-token: <your_jwt_token>"

200

{
  "courses": [
    {
      "_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": ""
    }
  ]
}