Yoobic Bots API

This API is exclusively used to handle bots external to YOOBIC. External bots are an AI feature of the YOOBIC chat that enhances user interactions by automating workflows and streamlining processes to boost efficiency. By using third party bot APIs on top of the YOOBIC NEO chatbots, we enable users to access an unlimited number of specialised bots for back-office automations, HR, IT help, and more. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`bot_id` | string | | x | | Unique id of the bot | |`creator_id` | string | | x | | Unique id of the badge creator | |`name` | string | | | | Bot name | |`is_active` | boolean | | | | Enable or disable this bot (default: true) | |`webhook_url` | string | | | | Unique http target url to the bot | |`created_date` | date | | x | | Creation date | |`updated_date` | date | | x | x | Last update date |

Operations 4

GET /public/api/bots/{id} Get #
GET /public/api/bots?filter={filter} Get All #
GET /public/api/bots/count?where={where} Count #
GET /public/api/bots/export?type={type}&filter={filter} Export #

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/yoobic-bots-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

yoobic-bots-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: YOOBIC Public Bots API
  version: ''
  description: Welcome to the **YOOBIC Public API** documentation.
servers:
- url: https://<base_url>/
tags:
- name: Bots
  description: This API is exclusively used to handle bots external to YOOBIC.
paths:
  /public/api/bots/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  bot_id:
                    type: string
                  name:
                    type: string
                  is_active:
                    type: boolean
                  webhook_url:
                    type: string
                  tenant:
                    type: string
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  bot_id: 666abc9a8c591700299636bd
                  name: FAQ Bot
                  is_active: true
                  webhook_url: https://8b3e-212-116-179-154.ngrok-free.app/webhook
                  tenant: workplace2
                  created_date: '2024-06-13T09:32:10.859Z'
                  updated_date: '2024-06-13T09:32:10.859Z'
              examples:
                response:
                  value:
                    bot_id: 666abc9a8c591700299636bd
                    name: FAQ Bot
                    is_active: true
                    webhook_url: https://8b3e-212-116-179-154.ngrok-free.app/webhook
                    tenant: workplace2
                    created_date: '2024-06-13T09:32:10.859Z'
                    updated_date: '2024-06-13T09:32:10.859Z'
      summary: Get
      operationId: Get
      description: Get a bot for the given id.
      tags:
      - Bots
      parameters:
      - name: id
        in: path
        description: The id of the bot
        required: true
        example: 666abc9a8c591700299636bd
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      security:
      - oauth2: []
  /public/api/bots?filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  paging:
                    type: object
                    properties:
                      total:
                        type: number
                      skip:
                        type: number
                      limit:
                        type: number
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        bot_id:
                          type: string
                        name:
                          type: string
                        is_active:
                          type: boolean
                        webhook_url:
                          type: string
                        created_date:
                          type: string
                        updated_date:
                          type: string
                      required:
                      - bot_id
                      - name
                      - is_active
                      - webhook_url
                      - created_date
                      - updated_date
                example:
                  paging:
                    total: 2
                    skip: 0
                    limit: 1000
                  data:
                  - bot_id: 666abc9a8c591700299636bd
                    name: FAQ Bot
                    is_active: true
                    webhook_url: https://8b3e-212-116-179-154.ngrok-free.app/webhook
                    created_date: '2024-06-13T09:32:10.859Z'
                    updated_date: '2024-06-13T09:32:10.859Z'
                  - bot_id: 666abc9a8c591700299636be
                    name: 'FAQ Bot #2'
                    is_active: true
                    webhook_url: https://8b3e-213-117-178-155.ngrok-free.app/webhook
                    created_date: '2024-06-13T09:32:10.859Z'
                    updated_date: '2024-06-13T09:32:10.859Z'
              examples:
                response:
                  value:
                    paging:
                      total: 2
                      skip: 0
                      limit: 1000
                    data:
                    - bot_id: 666abc9a8c591700299636bd
                      name: FAQ Bot
                      is_active: true
                      webhook_url: https://8b3e-212-116-179-154.ngrok-free.app/webhook
                      created_date: '2024-06-13T09:32:10.859Z'
                      updated_date: '2024-06-13T09:32:10.859Z'
                    - bot_id: 666abc9a8c591700299636be
                      name: 'FAQ Bot #2'
                      is_active: true
                      webhook_url: https://8b3e-213-117-178-155.ngrok-free.app/webhook
                      created_date: '2024-06-13T09:32:10.859Z'
                      updated_date: '2024-06-13T09:32:10.859Z'
      summary: Get All
      operationId: Get All
      description: Get all the bots.
      tags:
      - Bots
      parameters:
      - name: filter
        in: query
        description: A valid JSON filter object
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/bots/count?where={where}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                example:
                  count: 10
              examples:
                response:
                  value:
                    count: 10
      summary: Count
      operationId: Count
      description: Count all the existing entities based on the where filter
      tags:
      - Bots
      parameters:
      - name: where
        in: query
        description: A valid JSON [Where filter](#section-api-requests-filter-where)
        required: false
        example: '{ "property": "value" }'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/bots/export?type={type}&filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                  priority:
                    type: number
                  nextRunAt:
                    type: string
                  _id:
                    type: string
                example:
                  name: Export file
                  type: normal
                  priority: 0
                  nextRunAt: '2018-09-11T15:56:05.387Z'
                  _id: 5b97e5954b99568b4b9101af
              examples:
                response:
                  value:
                    name: Export file
                    type: normal
                    priority: 0
                    nextRunAt: '2018-09-11T15:56:05.387Z'
                    _id: 5b97e5954b99568b4b9101af
      summary: Export
      operationId: Export
      description: 'Export all results as a file.

        This action is asynchronous and returns the id of a job. See `jobs` endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.'
      tags:
      - Bots
      parameters:
      - name: type
        in: path
        description: The type of file, either `csv` (default value) or `excel`
        required: true
        example: csv
        schema:
          type: string
      - name: filter
        in: query
        description: A valid JSON filter object (does not accept a `fields` filter)
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
components:
  schemas:
    Default_Header:
      type: object
      required:
      - Authorization
      properties:
        Authorization:
          type: string
          example: Bearer JWT
  requestBodies:
    Get_AllBody:
      content:
        application/json:
          schema:
            type: object
            properties:
              Authorization:
                $ref: '#/components/schemas/Default_Header'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /
          tokenUrl: /
          scopes: {}