Sana Courses API

The Courses API from Sana — 6 operation(s) for courses.

OpenAPI Specification

sana-labs-courses-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Sana Assignments Courses API
  description: Tenant-scoped REST API for the Sana platform (Sana AI / Sana Agents and Sana Learn). All requests are authenticated with a Bearer access token obtained via the OAuth 2.0 client credentials flow and are scoped to a customer's <domain>.sana.ai tenant. The endpoints below are transcribed from Sana's public API reference and cover platform administration (users, groups, programs, courses, paths, assignments, teamspaces), reporting/insights, and standards-based integration surfaces (xAPI). SCIM 2.0 provisioning is offered at /scim/v2 and is not modeled here. AI agent/assistant capabilities are configured primarily in-product and are not exposed as a public chat-completions endpoint in this reference. No endpoints are fabricated; replace <domain> with your tenant domain.
  termsOfService: https://sanalabs.com/legal
  contact:
    name: Sana
    url: https://docs.sana.ai/api-docs/
  version: '0.0'
servers:
- url: https://<domain>.sana.ai
  description: Tenant-scoped base URL; replace <domain> with your Sana tenant.
security:
- bearerAuth: []
tags:
- name: Courses
paths:
  /api/v0/courses:
    get:
      operationId: listCourses
      tags:
      - Courses
      summary: List courses.
      responses:
        '200':
          description: OK
    post:
      operationId: createLinkCourse
      tags:
      - Courses
      summary: Create a link course.
      responses:
        '200':
          description: OK
  /api/v1/courses:
    post:
      operationId: createCourseV1
      tags:
      - Courses
      summary: Create a course (v1).
      responses:
        '200':
          description: OK
  /api/v1/courses/bulk-link-upsert:
    post:
      operationId: bulkLinkUpsertCourses
      tags:
      - Courses
      summary: Bulk upsert link courses.
      responses:
        '200':
          description: OK
  /api/v0/courses/{courseId}:
    parameters:
    - name: courseId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getCourse
      tags:
      - Courses
      summary: Get a course.
      responses:
        '200':
          description: OK
    patch:
      operationId: updateCourse
      tags:
      - Courses
      summary: Update a course.
      responses:
        '200':
          description: OK
    delete:
      operationId: deleteCourse
      tags:
      - Courses
      summary: Delete a course.
      responses:
        '200':
          description: OK
  /api/v0/courses/{courseId}/completed/{userId}:
    parameters:
    - name: courseId
      in: path
      required: true
      schema:
        type: string
    - name: userId
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: markCourseCompleted
      tags:
      - Courses
      summary: Mark course completion for a user.
      responses:
        '200':
          description: OK
  /api/v0/courses/{courseId}/reset/{userId}:
    parameters:
    - name: courseId
      in: path
      required: true
      schema:
        type: string
    - name: userId
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: resetCourseProgress
      tags:
      - Courses
      summary: Reset course progress for a user.
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer access token obtained from POST /api/token via the OAuth 2.0 client credentials flow. Sent as: Authorization: Bearer <accessToken>.'