openapi: 3.0.3
info:
  title: Ask Sage Server Admin Usage 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: Usage
  description: Token usage tracking
paths:
  /count-monthly-tokens:
    get:
      summary: Get monthly token usage
      description: Returns the count of tokens used this month
      tags:
      - Usage
      responses:
        '200':
          description: Token count
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: integer
                  status:
                    type: integer
    post:
      summary: Get monthly token usage
      description: Returns the count of tokens used this month for specific app
      tags:
      - Usage
      responses:
        '200':
          description: Token count
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: integer
                  status:
                    type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                app_name:
                  type: string
                  default: asksage
                  description: Application name to filter token count
  /count-monthly-teach-tokens:
    get:
      summary: Get monthly teaching token usage
      description: Returns the count of teaching/training tokens used this month
      tags:
      - Usage
      responses:
        '200':
          description: Teaching token count
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: integer
                  status:
                    type: integer
    post:
      summary: Get monthly teaching token usage
      description: Returns the count of teaching/training tokens used this month
      tags:
      - Usage
      responses:
        '200':
          description: Teaching token count
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: integer
                  status:
                    type: integer
  /count-monthly-tokens-left-with-org:
    post:
      summary: Get remaining monthly tokens with organization
      description: Returns the number of tokens remaining for the month, accounting for both user and organization limits
      tags:
      - Usage
      responses:
        '200':
          description: Remaining tokens
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: integer
                    description: Number of tokens remaining
                  status:
                    type: integer
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.