Ask Sage Sources API

Source management within workbooks

Operations 3

PUT /source Add source to workbook #
DELETE /source Delete source #
POST /get-sources Get sources for workbook #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/ask-sage:ask-sage-sources-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ask-sage-sources-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Ask Sage User API — Full Response Reference Sources API
  description: 'Ask Sage User API for account management, organization administration, billing, and platform configuration.


    ## Base URL

    `https://api.asksage.ai/user`


    ## Authentication

    Most endpoints require a valid JWT token sent in the `x-access-tokens` HTTP header. Secured endpoints show a padlock in Swagger UI / Redoc — click **Authorize** and paste your token once to apply it to every request.


    Get a token from `/get-token-with-api-key` (your email + 64-character API key), then send it on each call:


    `x-access-tokens: `


    **No token required:** `/get-token-with-api-key`, `/register`, `/verify-email`, `/lost-pass`, and `GET /get-headers`.


    Beyond a valid token, admin (`admin-*`) and superadmin (`superadmin-*`) endpoints require the caller to hold the matching role, and many identify the target user via an `email` field in the request body.

    ## Key Features

    - **User Management** — Profile updates, API key management, login history

    - **Chat Sessions** — Create, retrieve, and manage conversation history

    - **Dataset Management** — Create datasets, manage permissions and assignments

    - **Workbooks** — Organize research with sources and memos

    - **Organization Admin** — User management, token allocation, usage reporting

    - **Superadmin** — Platform-wide administration and analytics'
  version: '2.0'
  contact:
    name: Support
    email: support@asksage.ai
    url: https://asksage.ai
servers:
- url: '{baseUrl}/user'
  description: Ask Sage User 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: Sources
  description: Source management within workbooks
paths:
  /source:
    put:
      summary: Add source to workbook
      tags:
      - Sources
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              - source_type
              - identifier
              properties:
                workbook_id:
                  type: integer
                  description: Numeric id of the workbook the source is added to; caller must have access to it.
                source_type:
                  type: string
                  description: Kind of source being added, indicating what the identifier refers to.
                  enum:
                  - filename
                  - url
                  - plain_text
                identifier:
                  type: string
                  description: Reference to the source content according to source_type (a file name, a URL, or the plain-text label); null bytes are stripped before storage.
                summary:
                  type: string
                  default: ''
                  description: Summary text describing the source; required and must be non-empty. Null bytes are stripped before storage.
                tags:
                  type: string
                  default: ''
                  description: 'Accepted for compatibility but ignored: the handler overwrites it to an empty string before saving, so any supplied value is not persisted.'
                full_text:
                  type: string
                  default: ''
                  description: Full text content of the source; required and must be non-empty. Null bytes are stripped before storage.
      responses:
        '200':
          description: Source added to workbook
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: string
                    description: Literal 'OK'
                  status:
                    type: integer
                    example: 200
        '400':
          description: 'Bot disabled, server issue, or ''Contact customer support'' service error (envelope status 400). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Bad request
                status: 400
        '404':
          description: 'Workbook not found or not owned by user (envelope status 404). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Not found
                status: 404
        '408':
          description: 'Missing required fields or invalid source_type (envelope status 408). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Error
                status: 408
      operationId: putSource
      x-operation-id-source: derived
    delete:
      summary: Delete source
      tags:
      - Sources
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - source_id
              properties:
                source_id:
                  type: integer
                  description: Numeric id of the source to delete; caller must be owner or organization admin of the workbook the source belongs to.
      responses:
        '200':
          description: Source deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: string
                    description: Literal 'Source deleted successfully'
                  status:
                    type: integer
                    example: 200
        '400':
          description: 'Bot disabled, server issue, or ''Contact customer support'' service error (envelope status 400). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Bad request
                status: 400
        '403':
          description: 'No owner/admin access (envelope status 403). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Forbidden
                status: 403
        '404':
          description: 'Source or workbook not found / not owned by user (envelope status 404). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Not found
                status: 404
      operationId: deleteSource
      x-operation-id-source: derived
  /get-sources:
    post:
      summary: Get sources for workbook
      tags:
      - Sources
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workbook_id
              properties:
                workbook_id:
                  type: integer
                  description: Numeric id of the workbook whose sources are returned; caller must have access to it.
      responses:
        '200':
          description: List of sources for the workbook
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        workbook_id:
                          type: integer
                        date_time:
                          type: string
                          description: Timestamp serialized as string
                          example: '2026-01-01T00:00:00Z'
                        source_type:
                          type: string
                          description: From Source.type
                        identifier:
                          type: string
                        summary:
                          type: string
                        tags:
                          type: string
                        full_text:
                          type: string
                  status:
                    type: integer
                    example: 200
        '400':
          description: 'Bot disabled or ''Server issue'' (envelope status 400). NOTE: this outcome is returned with HTTP 200; the code appears only in the JSON body ''status'' field.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                response: Bad request
                status: 400
      operationId: postGetSources
      x-operation-id-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard Ask Sage error envelope.
      properties:
        response:
          type: string
          description: Human-readable error message.
        status:
          type: integer
          example: 400
          description: HTTP-style status code (usually an integer; some endpoints return it as a numeric string).
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-tokens
      description: JWT authentication token. Obtain a token by calling `/get-token-with-api-key` with your email and 64-character API key. Some admin and superadmin endpoints also require an email address in the request body to identify the target user.
x-provenance:
  method: harvested
  publisher: Ask Sage
  source: https://docs.asksage.ai/api-docs/specs/user-api-spec.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)