Sana Programs API

openapi: 3.1.0
info:
  title: Sana Assignments Programs 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: Programs
paths:
  /api/v0/programs:
    get:
      operationId: listPrograms
      tags:
      - Programs
      summary: List programs
      parameters:
      - $ref: '#/components/parameters/next'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: A page of programs
    post:
      operationId: createProgram
      tags:
      - Programs
      summary: Create a program
      responses:
        '201':
          description: Program created
  /api/v0/programs/{programId}:
    get:
      operationId: getProgram
      tags:
      - Programs
      summary: Retrieve a program
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: A program
    patch:
      operationId: updateProgram
      tags:
      - Programs
      summary: Update a program
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: Program updated
    delete:
      operationId: deleteProgram
      tags:
      - Programs
      summary: Delete a program
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '204':
          description: Program deleted
  /api/v0/programs/{programId}/members:
    post:
      operationId: enrollProgramMembers
      tags:
      - Programs
      summary: Enroll users in a program
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: Users enrolled
    delete:
      operationId: unenrollProgramMembers
      tags:
      - Programs
      summary: Unenroll users from a program
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '204':
          description: Users unenrolled
components:
  parameters:
    programId:
      name: programId
      in: path
      required: true
      schema:
        type: string
    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
  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)