vCita Staff AI Settings API

The Staff AI Settings API from vCita — 1 operation(s) for staff ai settings.

GitHub OpenAPI

Operations 2

GET /v3/ai/staff_ai_settings/{staff_uid} Retrieve a StaffAiSettings #
PUT /v3/ai/staff_ai_settings/{staff_uid} Update a StaffAiSettings #

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-staff-ai-settings-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-staff-ai-settings-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Staff AI Settings 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: Staff AI Settings
paths:
  /v3/ai/staff_ai_settings/{staff_uid}:
    get:
      tags:
      - Staff AI Settings
      summary: Retrieve a StaffAiSettings
      description: '## Overview

        Retrieve a specific StaffAiSettings based on staff unique identifier.


        **Available for Staff tokens**'
      parameters:
      - name: staff_uid
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The unique identifier of the staff member
        example: f390f1ee-6c54-4b01-90e6-d701748f0852
      responses:
        '200':
          description: Staff AI settings retrieved successfully
          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:
                      title: StaffAiSettings
                      description: AI settings configuration for a staff member, controlling which AI features and recommendations are enabled
                      type: object
                      properties:
                        staff_uid:
                          type: string
                          format: uuid
                          description: The unique identifier of the staff member these settings belong to
                        ai_recommendations:
                          type: object
                          description: AI recommendations settings configuration for a staff member
                          properties:
                            enable:
                              type: boolean
                              description: Whether AI recommendations are enabled for this staff member
                            sub_options:
                              type: object
                              description: Specific AI recommendation sub-options that can be enabled or disabled individually
                              properties:
                                next_best_action:
                                  type: boolean
                                  description: Whether next best action recommendations are enabled
                                estimate:
                                  type: boolean
                                  description: Whether estimate recommendations are enabled
                                scheduling:
                                  type: boolean
                                  description: Whether scheduling recommendations are enabled
                              required:
                              - next_best_action
                              - estimate
                              - scheduling
                          required:
                          - enable
                          - sub_options
                        smart_reply:
                          type: object
                          description: Smart reply settings configuration for a staff member
                          properties:
                            enable:
                              type: boolean
                              description: Whether smart reply feature is enabled for this staff member
                          required:
                          - enable
                        created_at:
                          type: string
                          format: date-time
                          description: The timestamp when the settings were created, in ISO 8601 format
                          readOnly: true
                        updated_at:
                          type: string
                          format: date-time
                          description: The timestamp when the settings were last updated, in ISO 8601 format
                          readOnly: true
                      required:
                      - staff_uid
                      example:
                        staff_uid: f390f1ee-6c54-4b01-90e6-d701748f0852
                        ai_recommendations:
                          enable: true
                          sub_options:
                            next_best_action: true
                            estimate: false
                            scheduling: true
                        smart_reply:
                          enable: true
                        created_at: '2025-01-20T14:00:00.000Z'
                        updated_at: '2025-01-20T14:30:00.000Z'
        '403':
          description: Forbidden - You can only access your own settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Staff member not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - Bearer: []
      operationId: getV3AiStaffAiSettingsByStaffUid
      x-operation-id-source: derived
    put:
      tags:
      - Staff AI Settings
      summary: Update a StaffAiSettings
      description: '## Overview

        Update AI settings for a specific staff member based on their unique identifier. Users can only update their own settings.


        **Available for Staff tokens**'
      parameters:
      - name: staff_uid
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The unique identifier of the staff member
        example: f390f1ee-6c54-4b01-90e6-d701748f0852
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaffAiSettingsRequest'
      responses:
        '200':
          description: Staff AI settings updated successfully
          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:
                      title: StaffAiSettings
                      description: AI settings configuration for a staff member, controlling which AI features and recommendations are enabled
                      type: object
                      properties:
                        staff_uid:
                          type: string
                          format: uuid
                          description: The unique identifier of the staff member these settings belong to
                        ai_recommendations:
                          type: object
                          description: AI recommendations settings configuration for a staff member
                          properties:
                            enable:
                              type: boolean
                              description: Whether AI recommendations are enabled for this staff member
                            sub_options:
                              type: object
                              description: Specific AI recommendation sub-options that can be enabled or disabled individually
                              properties:
                                next_best_action:
                                  type: boolean
                                  description: Whether next best action recommendations are enabled
                                estimate:
                                  type: boolean
                                  description: Whether estimate recommendations are enabled
                                scheduling:
                                  type: boolean
                                  description: Whether scheduling recommendations are enabled
                              required:
                              - next_best_action
                              - estimate
                              - scheduling
                          required:
                          - enable
                          - sub_options
                        smart_reply:
                          type: object
                          description: Smart reply settings configuration for a staff member
                          properties:
                            enable:
                              type: boolean
                              description: Whether smart reply feature is enabled for this staff member
                          required:
                          - enable
                        created_at:
                          type: string
                          format: date-time
                          description: The timestamp when the settings were created, in ISO 8601 format
                          readOnly: true
                        updated_at:
                          type: string
                          format: date-time
                          description: The timestamp when the settings were last updated, in ISO 8601 format
                          readOnly: true
                      required:
                      - staff_uid
                      example:
                        staff_uid: f390f1ee-6c54-4b01-90e6-d701748f0852
                        ai_recommendations:
                          enable: true
                          sub_options:
                            next_best_action: true
                            estimate: false
                            scheduling: true
                        smart_reply:
                          enable: true
                        created_at: '2025-01-20T14:00:00.000Z'
                        updated_at: '2025-01-20T14:30:00.000Z'
        '400':
          description: Bad request - Invalid setting key or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - You can only update your own settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Staff member not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - Bearer: []
      operationId: putV3AiStaffAiSettingsByStaffUid
      x-operation-id-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: The name of the field that caused the error (e.g., "uid", "status").
              code:
                type: string
                description: A machine-readable error code (e.g., "invalid", "required", "not_found").
              message:
                type: string
                description: A human-readable error message describing the issue.
      required:
      - success
      - errors
    StaffAiSettingsRequest:
      type: object
      properties:
        ai_recommendations:
          type: object
          description: AI recommendations settings configuration for a staff member
          properties:
            enable:
              type: boolean
              description: Whether AI recommendations are enabled for this staff member
            sub_options:
              type: object
              description: Specific AI recommendation sub-options that can be enabled or disabled individually
              properties:
                next_best_action:
                  type: boolean
                  description: Whether next best action recommendations are enabled
                estimate:
                  type: boolean
                  description: Whether estimate recommendations are enabled
                scheduling:
                  type: boolean
                  description: Whether scheduling recommendations are enabled
              required:
              - next_best_action
              - estimate
              - scheduling
          required:
          - enable
          - sub_options
        smart_reply:
          type: object
          description: Smart reply settings configuration for a staff member
          properties:
            enable:
              type: boolean
              description: Whether smart reply feature is enabled for this staff member
          required:
          - enable
      example:
        ai_recommendations:
          enable: true
          sub_options:
            next_best_action: true
            estimate: false
            scheduling: true
        smart_reply:
          enable: true
  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