Rulebase

Rulebase Bot Topics API

The Bot Topics API from Rulebase — 5 operation(s) for bot topics.

GitHub OpenAPI

Operations 5

GET /bot-topics/proficiency-gaps/{type} Get bot proficiency gap detail #
GET /bot-topics/generations/{generationId} Get bot topic generation #
GET /bot-topics/{topicId}/escalations Get bot topic escalations #
GET /bot-topics Get bot topic report #
GET /bot-topics/{topicId}/examples Get bot topic examples #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-bot-topics-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-bot-topics-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-bot-topics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Bot Topics API
  version: 0.0.1
tags:
- name: Bot Topics
paths:
  /bot-topics/proficiency-gaps/{type}:
    get:
      operationId: getBotProficiencyGapDetail
      parameters:
      - schema:
          type: string
          enum:
          - missing_data
          - knowledge
          - missing_tool
        required: true
        name: type
        in: path
      responses:
        '200':
          description: Organization-wide proficiency gap trends and recommendations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - missing_data
                        - knowledge
                        - missing_tool
                      from:
                        type: string
                      to:
                        type: string
                      gapCount:
                        type: integer
                      handoffCount:
                        type: integer
                      addressableCount:
                        type: integer
                      shareOfHandoffs:
                        type: number
                        nullable: true
                      addressableShare:
                        type: number
                        nullable: true
                      series:
                        type: array
                        items:
                          type: object
                          properties:
                            day:
                              type: string
                            gapCount:
                              type: integer
                            handoffCount:
                              type: integer
                            share:
                              type: number
                              nullable: true
                          required:
                          - day
                          - gapCount
                          - handoffCount
                          - share
                      recommendations:
                        type: array
                        items:
                          type: object
                          properties:
                            recommendationId:
                              type: string
                              format: uuid
                            reasonId:
                              type: string
                              format: uuid
                            topicId:
                              type: string
                              format: uuid
                            topicName:
                              type: string
                            type:
                              type: string
                              enum:
                              - knowledge
                              - instruction
                              - capability
                            title:
                              type: string
                            description:
                              type: string
                            ticketCount:
                              type: integer
                          required:
                          - recommendationId
                          - reasonId
                          - topicId
                          - topicName
                          - type
                          - title
                          - description
                          - ticketCount
                    required:
                    - type
                    - from
                    - to
                    - gapCount
                    - handoffCount
                    - addressableCount
                    - shareOfHandoffs
                    - addressableShare
                    - series
                    - recommendations
                required:
                - data
        '404':
          description: Organization unavailable
      tags:
      - Bot Topics
      summary: Get bot proficiency gap detail
      x-summary-source: derived
  /bot-topics/generations/{generationId}:
    get:
      operationId: getBotTopicGeneration
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: generationId
        in: path
      responses:
        '200':
          description: Tenant-scoped persisted topic generation and token usage
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      operation:
                        type: string
                      model:
                        type: string
                      status:
                        type: string
                      inputTokens:
                        type: number
                        nullable: true
                      outputTokens:
                        type: number
                        nullable: true
                      reservedTokens:
                        type: number
                      result:
                        nullable: true
                    required:
                    - id
                    - operation
                    - model
                    - status
                    - inputTokens
                    - outputTokens
                    - reservedTokens
                required:
                - data
        '404':
          description: Generation unavailable
      tags:
      - Bot Topics
      summary: Get bot topic generation
      x-summary-source: derived
  /bot-topics/{topicId}/escalations:
    get:
      operationId: getBotTopicEscalations
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: topicId
        in: path
      - schema:
          type: string
          format: uuid
        required: false
        name: botId
        in: query
      - schema:
          type: string
          format: date
        required: false
        name: from
        in: query
      - schema:
          type: string
          format: date
        required: false
        name: to
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
        required: false
        name: limit
        in: query
      - schema:
          type: integer
          nullable: true
          minimum: 0
          default: 0
        required: false
        name: offset
        in: query
      responses:
        '200':
          description: Evidence-grounded handoff reasons and analyzed tickets for one customer topic
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      topicId:
                        type: string
                        format: uuid
                      methodologyVersion:
                        type: integer
                      topicMethodologyVersion:
                        type: integer
                      from:
                        type: string
                      to:
                        type: string
                      escalationCount:
                        type: integer
                      analyzedCount:
                        type: integer
                      classifiedCount:
                        type: integer
                      correctToEscalateCount:
                        type: integer
                      addressableCount:
                        type: integer
                      insufficientEvidenceCount:
                        type: integer
                      coverage:
                        type: number
                        nullable: true
                      analysis:
                        type: string
                        nullable: true
                      dailySeries:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            escalated:
                              type: integer
                            contained:
                              type: integer
                          required:
                          - date
                          - escalated
                          - contained
                      reasons:
                        type: array
                        items:
                          type: object
                          properties:
                            reasonId:
                              type: string
                              format: uuid
                            name:
                              type: string
                            description:
                              type: string
                            cause:
                              type: string
                              enum:
                              - human_required
                              - knowledge_gap
                              - data_access_gap
                              - action_gap
                              - agent_failure
                            ticketCount:
                              type: integer
                            share:
                              type: number
                              nullable: true
                          required:
                          - reasonId
                          - name
                          - description
                          - cause
                          - ticketCount
                          - share
                      recommendations:
                        type: array
                        items:
                          type: object
                          properties:
                            recommendationId:
                              type: string
                              format: uuid
                            reasonId:
                              type: string
                              format: uuid
                            type:
                              type: string
                              enum:
                              - knowledge
                              - instruction
                              - capability
                            capabilitySubtype:
                              type: string
                              nullable: true
                              enum:
                              - read
                              - action
                              - repair
                            title:
                              type: string
                            description:
                              type: string
                            artifactTitle:
                              type: string
                            artifactContent:
                              type: string
                            acceptanceCriteria:
                              type: array
                              items:
                                type: string
                            ticketCount:
                              type: integer
                            estimatedMonthlyContainedTickets:
                              type: integer
                              minimum: 0
                            confidence:
                              type: number
                          required:
                          - recommendationId
                          - reasonId
                          - type
                          - capabilitySubtype
                          - title
                          - description
                          - artifactTitle
                          - artifactContent
                          - acceptanceCriteria
                          - ticketCount
                          - estimatedMonthlyContainedTickets
                          - confidence
                      tickets:
                        type: array
                        items:
                          type: object
                          properties:
                            conversationId:
                              type: string
                            externalId:
                              type: string
                              nullable: true
                            ticketSummary:
                              type: string
                            reasonId:
                              type: string
                              nullable: true
                              format: uuid
                            reasonName:
                              type: string
                              nullable: true
                            cause:
                              type: string
                              nullable: true
                              enum:
                              - human_required
                              - knowledge_gap
                              - data_access_gap
                              - action_gap
                              - agent_failure
                            humanOutcome:
                              type: string
                              enum:
                              - answered
                              - action_taken
                              - specialist_handled
                              - unresolved
                              - no_visible_resolution
                              - unclear
                            status:
                              type: string
                              enum:
                              - classified
                              - insufficient_evidence
                            confidence:
                              type: number
                          required:
                          - conversationId
                          - externalId
                          - ticketSummary
                          - reasonId
                          - reasonName
                          - cause
                          - humanOutcome
                          - status
                          - confidence
                    required:
                    - topicId
                    - methodologyVersion
                    - topicMethodologyVersion
                    - from
                    - to
                    - escalationCount
                    - analyzedCount
                    - classifiedCount
                    - correctToEscalateCount
                    - addressableCount
                    - insufficientEvidenceCount
                    - coverage
                    - analysis
                    - dailySeries
                    - reasons
                    - recommendations
                    - tickets
                required:
                - data
        '404':
          description: Topic unavailable
      tags:
      - Bot Topics
      summary: Get bot topic escalations
      x-summary-source: derived
  /bot-topics:
    get:
      operationId: getBotTopicReport
      parameters:
      - schema:
          type: string
          format: uuid
        required: false
        name: botId
        in: query
      - schema:
          type: string
          format: date
        required: false
        name: from
        in: query
      - schema:
          type: string
          format: date
        required: false
        name: to
        in: query
      responses:
        '200':
          description: Sample-based handoff rates by discovered customer intent
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                      methodologyVersion:
                        type: integer
                      taxonomyVersion:
                        type: integer
                      stage:
                        type: string
                        enum:
                        - collecting
                        - initial
                        - refining
                        - established
                      from:
                        type: string
                      to:
                        type: string
                      eligibleCount:
                        type: integer
                      selectedCount:
                        type: integer
                      requestCount:
                        type: integer
                      excludedCount:
                        type: integer
                      analyzedCount:
                        type: integer
                      notAnalyzedCount:
                        type: integer
                      coverage:
                        type: number
                        nullable: true
                      taxonomyQuality:
                        type: object
                        properties:
                          mappedRequestCount:
                            type: integer
                          agreementCount:
                            type: integer
                          disagreementCount:
                            type: integer
                          disagreements:
                            type: array
                            items:
                              type: object
                              properties:
                                conversationId:
                                  type: string
                                assignedTopicId:
                                  type: string
                                  format: uuid
                                assignedTopicName:
                                  type: string
                                mappedTopicId:
                                  type: string
                                  format: uuid
                                mappedTopicName:
                                  type: string
                                conversationFieldId:
                                  type: integer
                                externalFieldId:
                                  type: string
                                  nullable: true
                                fieldLabel:
                                  type: string
                                rawOptionValue:
                                  type: string
                                optionLabel:
                                  type: string
                              required:
                              - conversationId
                              - assignedTopicId
                              - assignedTopicName
                              - mappedTopicId
                              - mappedTopicName
                              - conversationFieldId
                              - externalFieldId
                              - fieldLabel
                              - rawOptionValue
                              - optionLabel
                        required:
                        - mappedRequestCount
                        - agreementCount
                        - disagreementCount
                        - disagreements
                      proficiencyGaps:
                        type: object
                        properties:
                          analyzedCount:
                            type: integer
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                  - missing_data
                                  - knowledge
                                  - missing_tool
                                count:
                                  type: integer
                                share:
                                  type: number
                              required:
                              - type
                              - count
                              - share
                        required:
                        - analyzedCount
                        - rows
                      rows:
                        type: array
                        items:
                          type: object
                          properties:
                            topicId:
                              type: string
                              format: uuid
                            parentTopicId:
                              type: string
                              nullable: true
                              format: uuid
                            depth:
                              type: integer
                              minimum: 0
                            hasChildren:
                              type: boolean
                            status:
                              type: string
                              enum:
                              - active
                              - retired
                            name:
                              type: string
                            description:
                              type: string
                            directAnalyzedCount:
                              type: integer
                            directHandoffCount:
                              type: integer
                            directRate:
                              type: number
                              nullable: true
                            analyzedCount:
                              type: integer
                            handoffCount:
                              type: integer
                            estimatedMonthlyVolume:
                              type: integer
                              minimum: 0
                            estimatedMonthlyAddressableCount:
                              type: integer
                              minimum: 0
                            rate:
                              type: number
                              nullable: true
                            rcsat:
                              type: number
                              nullable: true
                            lowVolume:
                              type: boolean
                          required:
                          - topicId
                          - parentTopicId
                          - depth
                          - hasChildren
                          - status
                          - name
                          - description
                          - directAnalyzedCount
                          - directHandoffCount
                          - directRate
                          - analyzedCount
                          - handoffCount
                          - estimatedMonthlyVolume
                          - estimatedMonthlyAddressableCount
                          - rate
                          - rcsat
                          - lowVolume
                    required:
                    - enabled
                    - methodologyVersion
                    - taxonomyVersion
                    - stage
                    - from
                    - to
                    - eligibleCount
                    - selectedCount
                    - requestCount
                    - excludedCount
                    - analyzedCount
                    - notAnalyzedCount
                    - coverage
                    - taxonomyQuality
                    - proficiencyGaps
                    - rows
                required:
                - data
      tags:
      - Bot Topics
      summary: Get bot topic report
      x-summary-source: derived
  /bot-topics/{topicId}/examples:
    get:
      operationId: getBotTopicExamples
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: topicId
        in: path
      - schema:
          type: string
          format: uuid
        required: false
        name: botId
        in: query
      - schema:
          type: string
          format: date
        required: false
        name: from
        in: query
      - schema:
          type: string
          format: date
        required: false
        name: to
        in: query
      responses:
        '200':
          description: Up to 20 analyzed conversations; same cohort as the report
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        conversationId:
                          type: string
                        externalId:
                          type: string
                          nullable: true
                        intent:
                          type: string
                          nullable: true
                        handedOff:
                          type: boolean
                        rcsat:
                          type: number
                          nullable: true
                      required:
                      - conversationId
                      - externalId
                      - intent
                      - handedOff
                      - rcsat
                required:
                - data
      tags:
      - Bot Topics
      summary: Get bot topic examples
      x-summary-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key