Sana Courses API

openapi: 3.1.0
info:
  title: Sana Assignments Courses API
  version: v0/v1
  description: Sana's REST API for the Sana AI knowledge/learning platform. Programmatic access to users, groups, programs, assignments, courses, paths, teamspaces, reporting/Insights, and xAPI statements. Authentication is OAuth 2.0 client credentials returning a bearer token; GET requests require the `read` scope and write requests require the `write` scope. The API is served per tenant at https://<domain>.sana.ai.
  contact:
    name: Sana API Documentation
    url: https://docs.sana.ai/api-docs/
servers:
- url: https://{domain}.sana.ai
  description: Per-tenant Sana host
  variables:
    domain:
      default: app
      description: Your Sana workspace subdomain
security:
- bearerAuth: []
tags:
- name: Courses
paths:
  /api/v0/courses:
    get:
      operationId: listCourses
      tags:
      - Courses
      summary: List courses
      parameters:
      - $ref: '#/components/parameters/next'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: A page of courses
    post:
      operationId: createLinkCourse
      tags:
      - Courses
      summary: Create a link course
      responses:
        '201':
          description: Link course created
  /api/v1/courses:
    post:
      operationId: createNativeCourse
      tags:
      - Courses
      summary: Create a native course
      responses:
        '201':
          description: Native course created
  /api/v1/courses/bulk-link-upsert:
    post:
      operationId: bulkLinkUpsertCourses
      tags:
      - Courses
      summary: Bulk create/update link courses
      responses:
        '200':
          description: Courses upserted
  /api/v0/courses/{courseId}:
    get:
      operationId: getCourse
      tags:
      - Courses
      summary: Retrieve a course
      parameters:
      - $ref: '#/components/parameters/courseId'
      responses:
        '200':
          description: A course
    patch:
      operationId: updateCourse
      tags:
      - Courses
      summary: Update a course
      parameters:
      - $ref: '#/components/parameters/courseId'
      responses:
        '200':
          description: Course updated
    delete:
      operationId: deleteCourse
      tags:
      - Courses
      summary: Delete a course
      parameters:
      - $ref: '#/components/parameters/courseId'
      responses:
        '204':
          description: Course deleted
  /api/v0/courses/{courseId}/completed/{userId}:
    post:
      operationId: markCourseCompleted
      tags:
      - Courses
      summary: Mark a course as completed for a user
      parameters:
      - $ref: '#/components/parameters/courseId'
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Completion recorded
  /api/v0/courses/{courseId}/reset/{userId}:
    post:
      operationId: resetCourseProgress
      tags:
      - Courses
      summary: Reset a user's course progress
      parameters:
      - $ref: '#/components/parameters/courseId'
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Progress reset
components:
  parameters:
    limit:
      name: limit
      in: query
      required: false
      description: Number of items to return (default 100, max 1000)
      schema:
        type: integer
        default: 100
        maximum: 1000
    next:
      name: next
      in: query
      required: false
      description: Cursor to fetch the next batch of results
      schema:
        type: string
    courseId:
      name: courseId
      in: path
      required: true
      schema:
        type: string
    userId:
      name: userId
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token obtained from POST /api/token via the OAuth 2.0 client credentials grant.
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{domain}.sana.ai/api/token
          scopes:
            read: Read access (required for GET requests)
            write: Write access (required for POST, PATCH, DELETE requests)