Rulebase

Rulebase Knowledge Base Documents API

The Knowledge Base Documents API from Rulebase — 2 operation(s) for knowledge base documents.

GitHub OpenAPI

Operations 5

GET /knowledge-base-documents Get knowledge base documents #
POST /knowledge-base-documents Create knowledge base documents #
GET /knowledge-base-documents/{documentId} Get knowledge base documents by document id #
PATCH /knowledge-base-documents/{documentId} Update knowledge base documents by document id #
DELETE /knowledge-base-documents/{documentId} Delete knowledge base documents by document id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-knowledge-base-documents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-qa-agent-evaluation-scorecard-criterion-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-linked-activity-thread-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-scorecard-form-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-evaluation-schedule-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-dry-run-schema.json

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/rulebase:rulebase-knowledge-base-documents-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.

GitHub Google LinkedIn

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

OpenAPI Specification

rulebase-knowledge-base-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Knowledge Base Documents API
  version: 0.0.1
tags:
- name: Knowledge Base Documents
paths:
  /knowledge-base-documents:
    get:
      parameters:
      - schema:
          type: string
          minLength: 1
          maxLength: 200
        required: false
        name: query
        in: query
      responses:
        '200':
          description: Organization knowledge base documents
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        organizationId:
                          type: string
                        agentId:
                          type: string
                          nullable: true
                        ownerType:
                          type: string
                          enum:
                          - organization
                        ownerId:
                          type: string
                        folderId:
                          type: string
                          nullable: true
                        title:
                          type: string
                        content:
                          type: string
                        isEnabled:
                          type: boolean
                        managedBy:
                          type: string
                          enum:
                          - user
                          - system
                        systemType:
                          type: string
                          nullable: true
                          enum:
                          - general
                          - onboarding
                        metadata:
                          type: object
                          nullable: true
                          additionalProperties:
                            nullable: true
                        createdByUserId:
                          type: string
                          nullable: true
                        authorName:
                          type: string
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                      - id
                      - organizationId
                      - agentId
                      - ownerType
                      - ownerId
                      - folderId
                      - title
                      - content
                      - isEnabled
                      - managedBy
                      - systemType
                      - metadata
                      - createdByUserId
                      - authorName
                      - createdAt
                      - updatedAt
                required:
                - data
      tags:
      - Knowledge Base Documents
      summary: Get knowledge base documents
      x-summary-source: derived
      operationId: getKnowledgeBaseDocuments
      x-operation-id-source: derived
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  minLength: 1
                  maxLength: 300
                content:
                  type: string
                  minLength: 1
                  maxLength: 200000
                folderId:
                  type: string
                  nullable: true
                  format: uuid
              required:
              - title
              - content
      responses:
        '201':
          description: Organization knowledge base document created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      agentId:
                        type: string
                        nullable: true
                      ownerType:
                        type: string
                        enum:
                        - organization
                      ownerId:
                        type: string
                      folderId:
                        type: string
                        nullable: true
                      title:
                        type: string
                      content:
                        type: string
                      isEnabled:
                        type: boolean
                      managedBy:
                        type: string
                        enum:
                        - user
                        - system
                      systemType:
                        type: string
                        nullable: true
                        enum:
                        - general
                        - onboarding
                      metadata:
                        type: object
                        nullable: true
                        additionalProperties:
                          nullable: true
                      createdByUserId:
                        type: string
                        nullable: true
                      authorName:
                        type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - organizationId
                    - agentId
                    - ownerType
                    - ownerId
                    - folderId
                    - title
                    - content
                    - isEnabled
                    - managedBy
                    - systemType
                    - metadata
                    - createdByUserId
                    - authorName
                    - createdAt
                    - updatedAt
                required:
                - data
        '400':
          description: Invalid folder
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Knowledge Base Documents
      summary: Create knowledge base documents
      x-summary-source: derived
      operationId: postKnowledgeBaseDocuments
      x-operation-id-source: derived
  /knowledge-base-documents/{documentId}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: documentId
        in: path
      responses:
        '200':
          description: Organization knowledge base document
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      agentId:
                        type: string
                        nullable: true
                      ownerType:
                        type: string
                        enum:
                        - organization
                      ownerId:
                        type: string
                      folderId:
                        type: string
                        nullable: true
                      title:
                        type: string
                      content:
                        type: string
                      isEnabled:
                        type: boolean
                      managedBy:
                        type: string
                        enum:
                        - user
                        - system
                      systemType:
                        type: string
                        nullable: true
                        enum:
                        - general
                        - onboarding
                      metadata:
                        type: object
                        nullable: true
                        additionalProperties:
                          nullable: true
                      createdByUserId:
                        type: string
                        nullable: true
                      authorName:
                        type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - organizationId
                    - agentId
                    - ownerType
                    - ownerId
                    - folderId
                    - title
                    - content
                    - isEnabled
                    - managedBy
                    - systemType
                    - metadata
                    - createdByUserId
                    - authorName
                    - createdAt
                    - updatedAt
                required:
                - data
        '404':
          description: Knowledge base document not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Knowledge Base Documents
      summary: Get knowledge base documents by document id
      x-summary-source: derived
      operationId: getKnowledgeBaseDocumentsByDocumentId
      x-operation-id-source: derived
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: documentId
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  minLength: 1
                  maxLength: 300
                content:
                  type: string
                  minLength: 1
                  maxLength: 200000
                folderId:
                  type: string
                  nullable: true
                  format: uuid
                isEnabled:
                  type: boolean
      responses:
        '200':
          description: Organization knowledge base document updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      agentId:
                        type: string
                        nullable: true
                      ownerType:
                        type: string
                        enum:
                        - organization
                      ownerId:
                        type: string
                      folderId:
                        type: string
                        nullable: true
                      title:
                        type: string
                      content:
                        type: string
                      isEnabled:
                        type: boolean
                      managedBy:
                        type: string
                        enum:
                        - user
                        - system
                      systemType:
                        type: string
                        nullable: true
                        enum:
                        - general
                        - onboarding
                      metadata:
                        type: object
                        nullable: true
                        additionalProperties:
                          nullable: true
                      createdByUserId:
                        type: string
                        nullable: true
                      authorName:
                        type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - organizationId
                    - agentId
                    - ownerType
                    - ownerId
                    - folderId
                    - title
                    - content
                    - isEnabled
                    - managedBy
                    - systemType
                    - metadata
                    - createdByUserId
                    - authorName
                    - createdAt
                    - updatedAt
                required:
                - data
        '400':
          description: Invalid folder
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: System document is read-only
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Knowledge base document not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Knowledge Base Documents
      summary: Update knowledge base documents by document id
      x-summary-source: derived
      operationId: patchKnowledgeBaseDocumentsByDocumentId
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: documentId
        in: path
      responses:
        '204':
          description: Organization knowledge base document deleted
        '403':
          description: System document is read-only
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Knowledge base document not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Knowledge Base Documents
      summary: Delete knowledge base documents by document id
      x-summary-source: derived
      operationId: deleteKnowledgeBaseDocumentsByDocumentId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key