vCita AI SmartReply API

Operations related to smart reply generation and management

GitHub OpenAPI

Operations 2

POST /v3/ai/ai_smart_replies Create a new AISmartReply #
GET /v3/ai/ai_smart_replies List all AISmartReplies #

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-ai-smartreply-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-ai-smartreply-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AI SmartReply 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: AI SmartReply
  description: Operations related to smart reply generation and management
paths:
  /v3/ai/ai_smart_replies:
    post:
      tags:
      - AI SmartReply
      summary: Create a new AISmartReply
      description: '## Overview

        Generate a new, on-demand, smart reply between a business and a client. For example, when a user wants to edit their own reply text, provide custom instructions, or modify a previously-generated AI reply.


        **Available for Staff tokens**'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AISmartReplyRequest'
      responses:
        '201':
          description: ' AISmartReply created successfully'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    description: Represents a smart reply generated by AI with different message formats for various communication channels.
                    properties:
                      uid:
                        type: string
                        description: The unique identifier (UID) of the smart reply
                      created_at:
                        type: string
                        format: date-time
                        description: The timestamp when the smart reply was created, in ISO 8601 format
                      updated_at:
                        type: string
                        format: date-time
                        description: The timestamp when the smart reply was last updated, in ISO 8601 format
                      display:
                        type: object
                        description: Contains display-related information for the smart reply.
                        properties:
                          btn_text:
                            type: string
                            description: A human-readable title for the smart reply button.
                      reason:
                        type: string
                        description: The reason why this smart reply was generated, providing context for decision-making.
                      payload:
                        type: object
                        description: Contains the generated reply messages for different communication channels.
                        properties:
                          email_message:
                            type: string
                            description: The generated reply formatted for email communication
                          sms_message:
                            type: string
                            description: The generated reply formatted for SMS communication
                          FB_message:
                            type: string
                            description: The generated reply formatted for Facebook messaging
                          other_message:
                            type: string
                            description: The generated reply formatted for other communication channels
                        required:
                        - email_message
                        - sms_message
                        - FB_message
                        - other_message
                      evidence:
                        oneOf:
                        - type: array
                          items:
                            type: string
                        - type: string
                        description: Supporting statements or facts that led to the generation of this smart reply. Can be an array of strings or a single string.
                      matter_uid:
                        type: string
                        description: The unique identifier of the associated matter
                    required:
                    - uid
                    - created_at
                    - updated_at
                    - reason
                    - payload
                    - matter_uid
                    example:
                      uid: d290f1ee-6c54-4b01-90e6-d701748f0851
                      created_at: '2025-02-04T14:00:00.000Z'
                      updated_at: '2025-02-04T14:00:00.000Z'
                      display:
                        btn_text: Generate Reply
                      reason: User needs clarification on pricing
                      payload:
                        email_message: I need more details to send you a quote<br/>best regards,<br/>ramster
                        sms_message: I need more details to send you a quote
                        FB_message: I need more details to send you a quote
                        other_message: I need more details to send you a quote
                      evidence:
                      - User asked for price estimate
                      matter_uid: 7f8a9b32d4e
        '400':
          description: Invalid request parameters
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error - AI smart reply generation failed. This can occur when the AI agent fails to generate a response (e.g., no output generated, processing errors). This is expected behavior for certain edge cases.
      security:
      - Bearer: []
      operationId: postV3AiAiSmartReplies
      x-operation-id-source: derived
    get:
      tags:
      - AI SmartReply
      summary: List all AISmartReplies
      description: '## Overview

        Retrieve a list of smart replies with optional filtering.


        Available for **Staff, Directory, and Client tokens**'
      parameters:
      - name: matter_uid
        in: query
        description: Filter by matter UID
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: Page number for pagination
        required: false
        schema:
          type: integer
          default: 1
      - name: per_page
        in: query
        description: Number of items per page
        required: false
        schema:
          type: integer
          default: 20
          maximum: 100
      responses:
        '200':
          description: List of smart replies retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/SmartReplyListResponse'
        '401':
          description: Unauthorized
      security:
      - Bearer: []
      operationId: getV3AiAiSmartReplies
      x-operation-id-source: derived
components:
  schemas:
    AISmartReplyRequest:
      type: object
      properties:
        matter_uid:
          type: string
          description: The unique identifier of the associated matter
        user_input_reference_id:
          type: string
          description: The unique identifier of the user input reference. If not provided, defaults to 'prmpt-smart-reply-00001'
          default: prmpt-smart-reply-00001
        client_uid:
          type: string
          description: The unique identifier of the client
        custom_instructions:
          type: string
          description: Optional custom instructions to guide the AI reply generation
      required:
      - matter_uid
      - client_uid
    SmartReplyListResponse:
      type: object
      properties:
        smart_replies:
          type: array
          items:
            type: object
            description: Represents a smart reply generated by AI with different message formats for various communication channels.
            properties:
              uid:
                type: string
                description: The unique identifier (UID) of the smart reply
              created_at:
                type: string
                format: date-time
                description: The timestamp when the smart reply was created, in ISO 8601 format
              updated_at:
                type: string
                format: date-time
                description: The timestamp when the smart reply was last updated, in ISO 8601 format
              display:
                type: object
                description: Contains display-related information for the smart reply.
                properties:
                  btn_text:
                    type: string
                    description: A human-readable title for the smart reply button.
              reason:
                type: string
                description: The reason why this smart reply was generated, providing context for decision-making.
              payload:
                type: object
                description: Contains the generated reply messages for different communication channels.
                properties:
                  email_message:
                    type: string
                    description: The generated reply formatted for email communication
                  sms_message:
                    type: string
                    description: The generated reply formatted for SMS communication
                  FB_message:
                    type: string
                    description: The generated reply formatted for Facebook messaging
                  other_message:
                    type: string
                    description: The generated reply formatted for other communication channels
                required:
                - email_message
                - sms_message
                - FB_message
                - other_message
              evidence:
                oneOf:
                - type: array
                  items:
                    type: string
                - type: string
                description: Supporting statements or facts that led to the generation of this smart reply. Can be an array of strings or a single string.
              matter_uid:
                type: string
                description: The unique identifier of the associated matter
            required:
            - uid
            - created_at
            - updated_at
            - reason
            - payload
            - matter_uid
            example:
              uid: d290f1ee-6c54-4b01-90e6-d701748f0851
              created_at: '2025-02-04T14:00:00.000Z'
              updated_at: '2025-02-04T14:00:00.000Z'
              display:
                btn_text: Generate Reply
              reason: User needs clarification on pricing
              payload:
                email_message: I need more details to send you a quote<br/>best regards,<br/>ramster
                sms_message: I need more details to send you a quote
                FB_message: I need more details to send you a quote
                other_message: I need more details to send you a quote
              evidence:
              - User asked for price estimate
              matter_uid: 7f8a9b32d4e
  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