vCita BizAI Chats API

The BizAI Chats API from vCita — 2 operation(s) for bizai chats.

GitHub OpenAPI

Operations 3

GET /v3/ai/bizai_chats Get all BizAIChats #
POST /v3/ai/bizai_chats Create a BizAIChat #
GET /v3/ai/bizai_chats/{uid} Retrieve a BizAIChat #

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/vcita:vcita-bizai-chats-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

vcita-bizai-chats-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: BizAI Chats API
  description: Unified OpenAPI specification for ai domain
  version: '3.0'
  x-generated:
    sourceFiles:
    - recommendations.json
    - business_rules.json
    - business_ai_settings.json
    - bizai.json
    - ai_smart_reply.json
    - generic_ai.json
    - staff_ai_settings.json
    - ai_generation_feedback.json
    pathNormalizations: []
    pathConflicts: []
    componentConflicts:
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_business_rules
      files:
      - merged
      - business_rules.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_business_ai_settings
      files:
      - merged
      - business_ai_settings.json
    - type: schema
      name: Response
      resolution: Renamed to Response_ai_smart_reply
      files:
      - merged
      - ai_smart_reply.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_staff_ai_settings
      files:
      - merged
      - staff_ai_settings.json
    totalPaths: 20
    totalComponents: 33
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: BizAI Chats
paths:
  /v3/ai/bizai_chats:
    get:
      operationId: ChatsController_getChats
      summary: Get all BizAIChats
      description: '## Overview

        Get a list of all chat sessions.


        Available for **Staff, Directory, and Client tokens**'
      parameters:
      - name: page
        required: false
        in: query
        description: Page number of results.
        schema:
          minimum: 1
          maximum: 10000
          default: 1
          type: number
      - name: per_page
        required: false
        in: query
        description: 'How many items to return per page. Max: 100'
        schema:
          minimum: 1
          maximum: 100
          default: 25
          type: number
      - description: 'Sort by fields. Example: sort=created_at:asc,updated_at:desc'
        name: sort
        required: false
        in: query
        schema:
          default: updated_at:desc
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Indicates whether the API request was successful (true) or failed (false).
                    data:
                      type: object
                      description: 'The response payload. Present on successful responses (success: true).'
                    error:
                      type: string
                      description: Error message for simple error responses. Used in some legacy endpoints.
                    errors:
                      type: array
                      description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
                      items:
                        type: object
                        properties:
                          code:
                            type: string
                            description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
                          message:
                            type: string
                            description: Human-readable error message.
                          field:
                            type: string
                            description: The field that caused the error (for validation errors).
                        required:
                        - code
                        - message
                  required:
                  - success
                  description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
                - properties:
                    data:
                      $ref: '#/components/schemas/MultiChatResponseDto'
      tags:
      - BizAI Chats
      security:
      - Bearer: []
    post:
      operationId: ChatsController_createChat
      summary: Create a BizAIChat
      description: '## Overview

        Create a new chat session between a user and an agent Available for **Staff Tokens**.'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatRequestDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Indicates whether the API request was successful (true) or failed (false).
                    data:
                      type: object
                      description: 'The response payload. Present on successful responses (success: true).'
                    error:
                      type: string
                      description: Error message for simple error responses. Used in some legacy endpoints.
                    errors:
                      type: array
                      description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
                      items:
                        type: object
                        properties:
                          code:
                            type: string
                            description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
                          message:
                            type: string
                            description: Human-readable error message.
                          field:
                            type: string
                            description: The field that caused the error (for validation errors).
                        required:
                        - code
                        - message
                  required:
                  - success
                  description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
                - properties:
                    data:
                      type: object
                      properties:
                        uid:
                          type: string
                          description: The unique identifier (UID) of the chat
                        actor_uid:
                          type: string
                          description: The unique identifier (UID) of the actor that created the chat
                        agent:
                          type: string
                          description: Agent associated with the chat
                        metadata:
                          type: object
                          description: A JSON string used to pass additional information to the chat agent in run time
                        config:
                          type: object
                          description: The agent configuration settings for this chat session
                          properties:
                            instruction:
                              oneOf:
                              - type: string
                              - type: object
                              - type: 'null'
                              description: The instructions for the agent. Can be a simple string prompt, a structured object with template variables, or null if not configured.
                            model_name:
                              type: string
                              description: The AI model name used for the agent
                        created_at:
                          type: string
                          description: Date the chat was created
                        updated_at:
                          type: string
                          description: Date the chat was last updated
                      required:
                      - uid
                      - actor_uid
                      - agent
                      - created_at
                      - updated_at
                      example:
                        uid: d290f1ee-6c54-4b01-90e6-d701748f0851
                        actor_uid: ghp0f1ee-6c54-4b01-90e6-d701748f0851
                        agent: vanilla
                        metadata:
                          directory_uid: k98axtpqg7h1whh6
                          instruction: You are a helpful assistant. Answer all questions to the best of your ability.
                        config:
                          instruction: You are an experienced business consultant with a friendly voice.
                          model_name: gpt-4
                        created_at: '2021-07-20T14:00:00.000Z'
                        updated_at: '2021-07-20T14:00:00.000Z'
                      description: Represents a business AI chat session, including agent, metadata, and audit timestamps.
      tags:
      - BizAI Chats
      security:
      - Bearer: []
  /v3/ai/bizai_chats/{uid}:
    get:
      operationId: ChatsController_getChat
      summary: Retrieve a BizAIChat
      description: '## Overview

        Retrieve a specific BizAIChat session based on its unique identifier (UID).


        Available for **Staff, Directory, and Client tokens**'
      parameters:
      - name: uid
        required: true
        in: path
        description: Unique identifier of the BizAIChat
        schema:
          type: string
        example: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Indicates whether the API request was successful (true) or failed (false).
                    data:
                      type: object
                      description: 'The response payload. Present on successful responses (success: true).'
                    error:
                      type: string
                      description: Error message for simple error responses. Used in some legacy endpoints.
                    errors:
                      type: array
                      description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
                      items:
                        type: object
                        properties:
                          code:
                            type: string
                            description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
                          message:
                            type: string
                            description: Human-readable error message.
                          field:
                            type: string
                            description: The field that caused the error (for validation errors).
                        required:
                        - code
                        - message
                  required:
                  - success
                  description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
                - properties:
                    data:
                      type: object
                      properties:
                        uid:
                          type: string
                          description: The unique identifier (UID) of the chat
                        actor_uid:
                          type: string
                          description: The unique identifier (UID) of the actor that created the chat
                        agent:
                          type: string
                          description: Agent associated with the chat
                        metadata:
                          type: object
                          description: A JSON string used to pass additional information to the chat agent in run time
                        config:
                          type: object
                          description: The agent configuration settings for this chat session
                          properties:
                            instruction:
                              oneOf:
                              - type: string
                              - type: object
                              - type: 'null'
                              description: The instructions for the agent. Can be a simple string prompt, a structured object with template variables, or null if not configured.
                            model_name:
                              type: string
                              description: The AI model name used for the agent
                        created_at:
                          type: string
                          description: Date the chat was created
                        updated_at:
                          type: string
                          description: Date the chat was last updated
                      required:
                      - uid
                      - actor_uid
                      - agent
                      - created_at
                      - updated_at
                      example:
                        uid: d290f1ee-6c54-4b01-90e6-d701748f0851
                        actor_uid: ghp0f1ee-6c54-4b01-90e6-d701748f0851
                        agent: vanilla
                        metadata:
                          directory_uid: k98axtpqg7h1whh6
                          instruction: You are a helpful assistant. Answer all questions to the best of your ability.
                        config:
                          instruction: You are an experienced business consultant with a friendly voice.
                          model_name: gpt-4
                        created_at: '2021-07-20T14:00:00.000Z'
                        updated_at: '2021-07-20T14:00:00.000Z'
                      description: Represents a business AI chat session, including agent, metadata, and audit timestamps.
      tags:
      - BizAI Chats
      security:
      - Bearer: []
components:
  schemas:
    AgentConfigDto:
      type: object
      properties:
        instruction:
          type: string
          description: A prompt describing the basic instructions for the agent. The instructions are set at the beginning of a chat and set the tone and functionality for the entire conversation.
          example: You are an experienced business consultant with a friendly voice. Answer shortly and ask questions where more information is needed.
        model_name:
          type: string
          description: OpenAI model name to use for the agent
          example: gpt-3.5-turbo
    CreateChatRequestDto:
      type: object
      properties:
        agent:
          type: string
          description: "The agent code name. \n\nAvailable values: \n* vanilla - No business info included in the conversation\n* biz-ai - Seed information on the business is included, as well as a set of instructions to make the bot behave like a biz-ai chat."
          enum:
          - vanilla
          - biz-ai
          example: vanilla
        config:
          description: The agent configuration
          allOf:
          - $ref: '#/components/schemas/AgentConfigDto'
      required:
      - agent
    MultiChatResponseDto:
      type: object
      properties:
        bizai_chats:
          description: List of BizAIChats
          type: array
          items:
            type: object
            properties:
              uid:
                type: string
                description: The unique identifier (UID) of the chat
              actor_uid:
                type: string
                description: The unique identifier (UID) of the actor that created the chat
              agent:
                type: string
                description: Agent associated with the chat
              metadata:
                type: object
                description: A JSON string used to pass additional information to the chat agent in run time
              config:
                type: object
                description: The agent configuration settings for this chat session
                properties:
                  instruction:
                    oneOf:
                    - type: string
                    - type: object
                    - type: 'null'
                    description: The instructions for the agent. Can be a simple string prompt, a structured object with template variables, or null if not configured.
                  model_name:
                    type: string
                    description: The AI model name used for the agent
              created_at:
                type: string
                description: Date the chat was created
              updated_at:
                type: string
                description: Date the chat was last updated
            required:
            - uid
            - actor_uid
            - agent
            - created_at
            - updated_at
            example:
              uid: d290f1ee-6c54-4b01-90e6-d701748f0851
              actor_uid: ghp0f1ee-6c54-4b01-90e6-d701748f0851
              agent: vanilla
              metadata:
                directory_uid: k98axtpqg7h1whh6
                instruction: You are a helpful assistant. Answer all questions to the best of your ability.
              config:
                instruction: You are an experienced business consultant with a friendly voice.
                model_name: gpt-4
              created_at: '2021-07-20T14:00:00.000Z'
              updated_at: '2021-07-20T14:00:00.000Z'
            description: Represents a business AI chat session, including agent, metadata, and audit timestamps.
      required:
      - bizai_chats
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
  method: searched
  source: https://developers.intandem.tech:443/reference
  harvested: '2026-11-15'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.intandem.tech/reference/businessrulescontroller_createbulkimportjob.md
  - https://developers.intandem.tech/reference/businessrulescontroller_createbusinessrule.md
  - https://developers.intandem.tech/reference/businessrulescontroller_deletebusinessrule.md
  - https://developers.intandem.tech/reference/businessrulescontroller_getbusinessrule.md
  - https://developers.intandem.tech/reference/businessrulescontroller_getbusinessrules.md
  - https://developers.intandem.tech/reference/businessrulescontroller_gethistory.md
  - https://developers.intandem.tech/reference/businessrulescontroller_gethistoryrecord.md
  - https://developers.intandem.tech/reference/businessrulescontroller_updatebusinessrule.md
  - https://developers.intandem.tech/reference/chatmessagescontroller_createmessage.md
  - https://developers.intandem.tech/reference/chatmessagescontroller_getmessages.md
  - https://developers.intandem.tech/reference/chatscontroller_createchat.md
  - https://developers.intandem.tech/reference/chatscontroller_getchat.md
  - https://developers.intandem.tech/reference/chatscontroller_getchats.md
  - https://developers.intandem.tech/reference/createaigenerationfeedback.md
  - https://developers.intandem.tech/reference/get_v3-ai-ai-recommendations.md
  - https://developers.intandem.tech/reference/get_v3-ai-ai-smart-replies.md
  - https://developers.intandem.tech/reference/get_v3-ai-chat-completion-runs-uid.md
  - https://developers.intandem.tech/reference/get_v3-ai-chat-completion-runs.md
  - https://developers.intandem.tech/reference/get_v3-ai-staff-ai-settings-staff-uid.md
  - https://developers.intandem.tech/reference/get_v3-ai-transcription-runs-uid.md
  - https://developers.intandem.tech/reference/get_v3-ai-transcription-runs.md
  - https://developers.intandem.tech/reference/getairecommendation.md
  - https://developers.intandem.tech/reference/getbusinessaisettings.md
  - https://developers.intandem.tech/reference/post_v3-ai-ai-recommendations.md
  - https://developers.intandem.tech/reference/post_v3-ai-ai-smart-replies.md
  - https://developers.intandem.tech/reference/post_v3-ai-audio-transcriptions.md
  - https://developers.intandem.tech/reference/post_v3-ai-chat-completions.md
  - https://developers.intandem.tech/reference/put_v3-ai-ai-recommendations-uid.md
  - https://developers.intandem.tech/reference/put_v3-ai-staff-ai-settings-staff-uid.md
  - https://developers.intandem.tech/reference/updatebusinessaisettings.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_createbulkimportjob.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_createbusinessrule.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_deletebusinessrule.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_getbusinessrule.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_getbusinessrules.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_gethistory.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_gethistoryrecord.md
  - https://developers.intandem.tech:443/reference/businessrulescontroller_updatebusinessrule.md
  - https://developers.intandem.tech:443/reference/chatmessagescontroller_createmessage.md
  - https://developers.intandem.tech:443/reference/chatmessagescontroller_getmessages.md
  - https://developers.intandem.tech:443/reference/chatscontroller_createchat.md
  - https://developers.intandem.tech:443/reference/chatscontroller_getchat.md
  - https://developers.intandem.tech:443/reference/chatscontroller_getchats.md
  - https://developers.intandem.tech:443/reference/createaigenerationfeedback.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-ai-recommendations.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-ai-smart-replies.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-chat-completion-runs-uid.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-chat-completion-runs.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-staff-ai-settings-staff-uid.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-transcription-runs-uid.md
  - https://developers.intandem.tech:443/reference/get_v3-ai-transcription-runs.md
  - https://developers.intandem.tech:443/reference/getairecommendation.md
  - https://developers.intandem.tech:443/reference/getbusinessaisettings.md
  - https://developers.intandem.tech:443/reference/post_v3-ai-ai-recommendations.md
  - https://developers.intandem.tech:443/reference/post_v3-ai-ai-smart-replies.md
  - https://developers.intandem.tech:443/reference/post_v3-ai-audio-transcriptions.md
  - https://developers.intandem.tech:443/reference/post_v3-ai-chat-completions.md
  - https://developers.intandem.tech:443/reference/put_v3-ai-ai-recommendations-uid.md
  - https://developers.intandem.tech:443/reference/put_v3-ai-staff-ai-settings-staff-uid.md
  - https://developers.intandem.tech:443/reference/updatebusinessaisettings.md
  merge:
    pages: 60
    deduped: 137
    conflicts_kept_first: 0