Treasure Data Knowledge Base API

The KnowledgeBase API from Treasure Data — 3 operation(s) for knowledgebase.

Operations 6

GET /api/knowledge_bases index
POST /api/knowledge_bases create
DELETE /api/knowledge_bases/{id} destroy
GET /api/knowledge_bases/{id} show
PATCH /api/knowledge_bases/{id} update
POST /api/knowledge_bases/{id}/query query

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/treasure-data-knowledgebase-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 email required.

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

OpenAPI Specification

treasure-data-knowledgebase-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: llm-api Knowledge Base API
  version: 1.0.0
servers:
- url: https://llm-api.treasuredata.com
- url: https://llm-api.eu01.treasuredata.com
- url: https://llm-api.ap02.treasuredata.com
- url: https://llm-api.treasuredata.co.jp
security:
- ApiKeyAuth: []
tags:
- name: KnowledgeBase
paths:
  /api/knowledge_bases:
    get:
      summary: index
      tags:
      - KnowledgeBase
      responses:
        '200':
          description: allows GET /api/knowledge_bases
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                        links:
                          type: object
                          properties:
                            self:
                              type: string
                          required:
                          - self
                        attributes:
                          type: object
                          properties:
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                            projectId:
                              type: string
                            name:
                              type: string
                            tdDatabaseName:
                              type: string
                            formatType:
                              type: string
                            maxRows:
                              type: integer
                            timeoutSeconds:
                              type: integer
                            isManaged:
                              type: boolean
                            tables:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  tdQuery:
                                    type: string
                                  enableData:
                                    type: boolean
                                  enableDataIndex:
                                    type: boolean
                                required:
                                - name
                                - tdQuery
                                - enableData
                                - enableDataIndex
                            lastJob:
                              type:
                              - object
                              - 'null'
                              properties:
                                status:
                                  type: string
                                message: {}
                                finishedAt: {}
                                logs: {}
                              required:
                              - status
                              - message
                              - finishedAt
                              - logs
                          required:
                          - createdAt
                          - updatedAt
                          - projectId
                          - name
                          - tdDatabaseName
                          - formatType
                          - maxRows
                          - timeoutSeconds
                          - isManaged
                          - tables
                          - lastJob
                        relationships:
                          type: object
                          properties:
                            createdBy:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                              required:
                              - data
                            updatedBy:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                              required:
                              - data
                          required:
                          - createdBy
                          - updatedBy
                      required:
                      - id
                      - type
                      - links
                      - attributes
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                    required:
                    - total
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                      last:
                        type: string
                    required:
                    - first
                    - last
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                        attributes:
                          type: object
                          properties:
                            name:
                              type: string
                            email:
                              type: string
                          required:
                          - name
                          - email
                      required:
                      - id
                      - type
                      - attributes
                required:
                - data
                - meta
                - links
              example:
                data:
                - id: 00000000-0000-0000-0000-000000000001
                  type: knowledgeBases
                  links:
                    self: http://www.example.com/api/knowledge_bases/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    name: ygpozuds
                    tdDatabaseName: dhjcmdvy
                    formatType: LEGACY_JSON
                    maxRows: 50
                    timeoutSeconds: 60
                    isManaged: true
                    tables: []
                    lastJob:
                      status: IN_PROGRESS
                      message: null
                      finishedAt: null
                      logs: null
                meta:
                  total: 1
                links:
                  first: http://www.example.com/api/knowledge_bases?page%5Blimit%5D=20&page%5Boffset%5D=0
                  last: http://www.example.com/api/knowledge_bases?page%5Blimit%5D=20&page%5Boffset%5D=0
                included:
                - id: 00000000-0000-0000-0000-000000000001
                  type: users
                  attributes:
                    name: Admin User
                    email: admin@example.com
        '401':
          description: Rejected by 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
      parameters:
      - name: include
        in: query
        required: false
        schema:
          type: string
        example: createdBy,updatedBy
      - name: sort
        in: query
        required: false
        schema:
          type: string
        example: id
    post:
      summary: create
      tags:
      - KnowledgeBase
      responses:
        '201':
          description: Knowledge base created successfully
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                        required:
                        - self
                      attributes:
                        type: object
                        properties:
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          projectId:
                            type: string
                          name:
                            type: string
                          tdDatabaseName:
                            type: string
                          formatType:
                            type: string
                          maxRows:
                            type: integer
                          timeoutSeconds:
                            type: integer
                          isManaged:
                            type: boolean
                          tables:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                tdQuery:
                                  type: string
                                enableData:
                                  type: boolean
                                enableDataIndex:
                                  type: boolean
                              required:
                              - name
                              - tdQuery
                              - enableData
                              - enableDataIndex
                          lastJob:
                            type:
                            - object
                            - 'null'
                            properties:
                              status:
                                type: string
                              message: {}
                              finishedAt: {}
                              logs: {}
                            required:
                            - status
                            - message
                            - finishedAt
                            - logs
                        required:
                        - createdAt
                        - updatedAt
                        - projectId
                        - name
                        - tdDatabaseName
                        - formatType
                        - maxRows
                        - timeoutSeconds
                        - isManaged
                        - tables
                        - lastJob
                    required:
                    - id
                    - type
                    - links
                    - attributes
                required:
                - data
              example:
                data:
                  id: 00000000-0000-0000-0000-000000000001
                  type: knowledgeBases
                  links:
                    self: http://www.example.com/api/knowledge_bases/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    name: name1
                    tdDatabaseName: db1
                    formatType: LEGACY_JSON
                    maxRows: 50
                    timeoutSeconds: 60
                    isManaged: false
                    tables:
                    - name: tbl1
                      tdQuery: select 1
                      enableData: false
                      enableDataIndex: false
                    lastJob:
                      status: IN_PROGRESS
                      message: null
                      finishedAt: null
                      logs: null
        '400':
          description: rejects POST /api/knowledge_bases
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        status:
                          type: string
                      required:
                      - title
                      - detail
                      - code
                      - status
                required:
                - errors
              example:
                errors:
                - title: Param not allowed
                  detail: isManaged is not allowed.
                  code: '105'
                  status: '400'
        '401':
          description: Rejected by 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
        '422':
          description: POST /api/knowledge_bases rejects {"formatType":"MARKDOWN_KV","timeoutSeconds":700}
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        source:
                          type: object
                          properties:
                            pointer:
                              type: string
                          required:
                          - pointer
                        status:
                          type: string
                        meta:
                          type: object
                          properties:
                            validationCode:
                              type: string
                          required:
                          - validationCode
                      required:
                      - title
                      - detail
                      - code
                      - source
                      - status
                      - meta
                required:
                - errors
              example:
                errors:
                - title: must be in 10..300
                  detail: timeoutSeconds - must be in 10..300
                  code: '100'
                  source:
                    pointer: /data/attributes/timeoutSeconds
                  status: '422'
                  meta:
                    validationCode: INVALID_FORMAT_OR_ASSOCIATION
                - title: can be set only if format type is LEGACY_JSON
                  detail: tables - can be set only if format type is LEGACY_JSON
                  code: '100'
                  source:
                    pointer: /data/attributes/tables
                  status: '422'
                  meta:
                    validationCode: LLM_KNOWLEDGE_BASE_TABLES_AVAILABLE_ONLY_WITH_LEGACY_JSON
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                    attributes:
                      type: object
                      properties:
                        name:
                          type: string
                        projectId:
                          type: string
                        tdDatabaseName:
                          type: string
                        formatType:
                          type: string
                        tables:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              tdQuery:
                                type: string
                              enableData:
                                type: boolean
                              enableDataIndex:
                                type: boolean
                            required:
                            - name
                            - tdQuery
                            - enableData
                            - enableDataIndex
                      required:
                      - name
                      - tdDatabaseName
                      - projectId
                  required:
                  - type
                  - attributes
              required:
              - data
            example:
              data:
                type: knowledge_bases
                attributes:
                  name: name1
                  projectId: 00000000-0000-0000-0000-000000000001
                  tdDatabaseName: db1
                  formatType: MARKDOWN_KV
                  tables:
                  - name: tbl1
                    tdQuery: select 1
                    enableData: false
                    enableDataIndex: false
  /api/knowledge_bases/{id}:
    delete:
      summary: destroy
      tags:
      - KnowledgeBase
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000001
      responses:
        '204':
          description: submits a RAG REMOVE job even with formatType=MARKDOWN_KV
        '401':
          description: Rejected by 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
        '403':
          description: rejects DELETE /api/knowledge_bases/:id
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '403'
                error: Forbidden
        '404':
          description: DELETE /api/knowledge_bases/:id returns 404 Not Found
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        status:
                          type: string
                      required:
                      - title
                      - detail
                      - code
                      - status
                required:
                - errors
              example:
                errors:
                - title: Record not found
                  detail: The record identified by 00000000-0000-0000-0000-000000000001 could not be found.
                  code: '404'
                  status: '404'
        '422':
          description: restricts deletion of a knowledge base if it is referenced by a variable
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        source:
                          type: object
                          properties:
                            pointer:
                              type: string
                          required:
                          - pointer
                        status:
                          type: string
                        meta:
                          type: object
                          properties:
                            validationCode:
                              type: string
                            referencedByTools:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                required:
                                - id
                            referencedByVariables:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                required:
                                - id
                          required:
                          - validationCode
                      required:
                      - title
                      - detail
                      - code
                      - source
                      - status
                      - meta
                required:
                - errors
              example:
                errors:
                - title: Cannot delete record because dependent referenced by variables exist
                  detail: Cannot delete record because dependent referenced by variables exist
                  code: '100'
                  source:
                    pointer: /data
                  status: '422'
                  meta:
                    validationCode: DEPENDENT_DESTROY_RESTRICTED_HAS_MANY
                    referencedByVariables:
                    - id: 00000000-0000-0000-0000-000000000001
    get:
      summary: show
      tags:
      - KnowledgeBase
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000001
      responses:
        '200':
          description: Knowledge base details and configuration
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                        required:
                        - self
                      attributes:
                        type: object
                        properties:
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          projectId:
                            type: string
                          name:
                            type: string
                          tdDatabaseName:
                            type: string
                          formatType:
                            type: string
                          maxRows:
                            type: integer
                          timeoutSeconds:
                            type: integer
                          isManaged:
                            type: boolean
                          tables:
                            type: array
                            items: {}
                          lastJob:
                            type: object
                            properties:
                              status:
                                type: string
                              message: {}
                              finishedAt: {}
                              logs: {}
                            required:
                            - status
                            - message
                            - finishedAt
                            - logs
                        required:
                        - createdAt
                        - updatedAt
                        - projectId
                        - name
                        - tdDatabaseName
                        - formatType
                        - maxRows
                        - timeoutSeconds
                        - isManaged
                        - tables
                        - lastJob
                    required:
                    - id
                    - type
                    - links
                    - attributes
                required:
                - data
              example:
                data:
                  id: 00000000-0000-0000-0000-000000000001
                  type: knowledgeBases
                  links:
                    self: http://www.example.com/api/knowledge_bases/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    name: sfimdaoe
                    tdDatabaseName: awqjtevx
                    formatType: LEGACY_JSON
                    maxRows: 50
                    timeoutSeconds: 60
                    isManaged: true
                    tables: []
                    lastJob:
                      status: IN_PROGRESS
                      message: null
                      finishedAt: null
                      logs: null
        '401':
          description: Unauthorized - authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
        '404':
          description: Knowledge base not found
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        status:
                          type: string
                      required:
                      - title
                      - detail
                      - code
                      - status
                required:
                - errors
              example:
                errors:
                - title: Record not found
                  detail: The record identified by 00000000-0000-0000-0000-000000000001 could not be found.
                  code: '404'
                  status: '404'
    patch:
      summary: update
      tags:
      - KnowledgeBase
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000001
      responses:
        '200':
          description: Knowledge base updated successfully
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                        required:
                        - self
                      attributes:
                        type: object
                        properties:
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          projectId:
                            type: string
                          name:
                            type: string
                          tdDatabaseName:
                            type: string
                          formatType:
                            type: string
                          maxRows:
                            type: integer
                          timeoutSeconds:
                            type: integer
                          isManaged:
                            type: boolean
                          tables:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                tdQuery:
                                  type: string
                                enableData:
                                  type:

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/treasure-data/refs/heads/main/openapi/treasure-data-knowledgebase-api-openapi.yml