openapi: 3.0.3
info:
  title: Ask Sage Server Admin Workbooks API
  description: 'Ask Sage is an AI-powered platform providing intelligent completions, knowledge management, and workflow automation.


    ## Base URL

    `https://api.asksage.ai`


    ## Authentication

    All endpoints require a valid JWT token passed via the `x-access-tokens` header, unless otherwise noted.


    Obtain a token by authenticating through the User API (`/user/get-token-with-api-key`).


    ## Message Format

    The `message` field in API requests can be either:

    - A single string prompt: `"What is Ask Sage?"`

    - An array of conversation messages: `[{"user": "me", "message": "what is Ask Sage?"}, {"user": "gpt", "message": "Ask Sage is an..."}]`


    ## Key Features

    - **AI Completions** — Query multiple LLM providers with a unified interface

    - **Knowledge Training** — Upload documents, files, and data to build custom datasets

    - **Tabular Data** — Ingest and query structured data (CSV, XLSX) with natural language

    - **Agent Builder** — Create, configure, and execute multi-step AI workflows

    - **Plugins** — Extend capabilities with built-in and custom plugins

    - **MCP Servers** — Connect to Model Context Protocol servers for tool integration'
  version: '2.0'
  contact:
    name: Ask Sage Support
    email: support@asksage.ai
    url: https://asksage.ai
servers:
- url: '{baseUrl}/server'
  description: Ask Sage Server API
  variables:
    baseUrl:
      default: https://api.asksage.ai
      description: API base URL. Use https://api.asksage.ai for production, or your self-hosted instance URL.
security:
- ApiKeyAuth: []
tags:
- name: Workbooks
  description: Workbook management
paths:
  /workbook:
    put:
      summary: Create workbook
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              properties:
                title:
                  type: string
                classification:
                  type: string
                  nullable: true
      responses:
        '200':
          description: Workbook created
    delete:
      summary: Delete workbook
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              properties:
                workbook_id:
                  type: integer
      responses:
        '200':
          description: Workbook deleted
  /workbook-chats:
    post:
      summary: Update workbook chats
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              - chats
              properties:
                workbook_id:
                  type: integer
                chats:
                  type: array
                  items:
                    type: object
      responses:
        '200':
          description: Workbook chats updated
  /workbook-summary:
    post:
      summary: Update workbook summary
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              - overall_summary
              properties:
                workbook_id:
                  type: integer
                overall_summary:
                  type: string
      responses:
        '200':
          description: Workbook summary updated
  /get-workbooks:
    post:
      summary: Get workbooks
      tags:
      - Workbooks
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                full:
                  type: boolean
                  default: true
      responses:
        '200':
          description: Workbooks retrieved
  /assign-workbook:
    post:
      summary: Assign workbook to user
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              - email
              properties:
                workbook_id:
                  type: integer
                email:
                  type: string
                  format: email
      responses:
        '200':
          description: Workbook assigned
  /deassign-workbook:
    post:
      summary: Remove workbook assignment
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              - email
              properties:
                workbook_id:
                  type: integer
                email:
                  type: string
                  format: email
      responses:
        '200':
          description: Workbook deassigned
  /get-workbook-assignments:
    post:
      summary: Get workbook assignments
      tags:
      - Workbooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              properties:
                workbook_id:
                  type: integer
      responses:
        '200':
          description: Assignments retrieved
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-tokens
      description: JWT authentication token. Obtain a token by calling the User API endpoint `/user/get-token-with-api-key` with your email and API key.