vCita BizAI Chat Messages API

The BizAI Chat Messages API from vCita — 1 operation(s) for bizai chat messages.

GitHub OpenAPI

Operations 2

GET /v3/ai/bizai_chat_messages Get all BizAIChatMessages #
POST /v3/ai/bizai_chat_messages Create a BizAIChatMessage #

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-chat-messages-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-chat-messages-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: BizAI Chat Messages 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 Chat Messages
paths:
  /v3/ai/bizai_chat_messages:
    get:
      operationId: ChatMessagesController_getMessages
      summary: Get all BizAIChatMessages
      description: '## Overview

        Get all BizAIChatMessages exchanged within a specific chat.


        Available for **Staff, Directory, and Client tokens**'
      parameters:
      - name: ai_chat_uid
        required: true
        in: query
        description: Unique identifier of the BizAIChat
        schema:
          type: string
      - 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/MultiMessageResponseDto'
      tags:
      - BizAI Chat Messages
      security:
      - Bearer: []
    post:
      operationId: ChatMessagesController_createMessage
      summary: Create a BizAIChatMessage
      description: '## Overview

        Create a new BizAIChatMessage in a BizAIChat thread and get an AI response Available for **Staff Tokens**.'
      parameters:
      - name: bizai_chat_uid
        required: true
        in: query
        description: Unique identifier of the BizAIChat
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMessageRequestDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  uid:
                    type: string
                    description: The unique identifier (UID) of the message
                  delta:
                    type: string
                    description: Token that is part of the content of the message
                  finish_reason:
                    type: string
                    description: The reason the stream has finished. If null, the stream is did not finish yet
                required:
                - uid
                - delta
                - finish_reason
                example:
                  uid: d290f1ee-6c54-4b01-90e6-d701748f0851
                  delta: Hello
                  finish_reason: null
                description: Represents a streamed token chunk for a BizAI chat message, with finish state.
      tags:
      - BizAI Chat Messages
      security:
      - Bearer: []
components:
  schemas:
    SendMessageRequestDto:
      type: object
      properties:
        type:
          type: string
          description: The type of message sent to the bot (free text or a saved prompt template). A saved prompt can include reusable instructions that can be retrieved from BizAI for advanced functionality.
          example: text
          enum:
          - text
          - prompt
        content:
          description: 'An object representing the content sent to the bot. Each prompt type must have its own object ("Text Content Object" for "text" and "Prompt Content Object" for "prompt"). Note: content must be an object, not a string.'
          oneOf:
          - $ref: '#/components/schemas/TextContentDto'
          - $ref: '#/components/schemas/PromptContentDto'
        streaming:
          type: boolean
          description: Stream response option. If true, the response will be streamed to the client. If false, the response will be sent as a single message
          default: true
      required:
      - type
      - content
      example:
        type: text
        content:
          text: Hello, I need help with drafting a contract for my client.
        streaming: true
    PromptContentDto:
      type: object
      properties:
        uid:
          type: string
          example: prompt-xyz123
          description: The uid of the prompt you wish to use
        variables:
          type: object
          example:
            name: John
            age: 30
          description: 'A key-value object listing values of variables you want BizAI to replace in the prompt. For more information consult our “Using Prompts” guide: https://dash.readme.com/project/vcita-developers-hub/v3.0/docs/using-prompts'
      required:
      - uid
      - variables
    MultiMessageResponseDto:
      type: object
      properties:
        bizai_chat_messages:
          description: List of BizAIChatMessages
          type: array
          items:
            type: object
            properties:
              uid:
                type: string
                description: The unique identifier (UID) of the message
              content:
                type: string
                description: The content of the message
              author_role:
                type: string
                description: The role of the author of the message
              created_at:
                type: string
                description: The date the message was created
              updated_at:
                type: string
                description: The date the message was last updated
            required:
            - uid
            - content
            - author_role
            - created_at
            - updated_at
            example:
              uid: d290f1ee-6c54-4b01-90e6-d701748f0851
              content: Hello, how can I help you?
              author_role: human
              created_at: '2021-07-20T14:00:00.000Z'
              updated_at: '2021-07-20T14:00:00.000Z'
            description: Represents a single message within a BizAI chat, including author role and timestamps.
      required:
      - bizai_chat_messages
    TextContentDto:
      type: object
      properties:
        text:
          type: string
          description: The text sent to the bot
          example: Tell me a joke!
      required:
      - text
  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