vCita Business AI Settings API
The Business AI Settings API from vCita — 1 operation(s) for business ai settings.
The Business AI Settings API from vCita — 1 operation(s) for business ai settings.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/vcita:vcita-business-ai-settings-api"
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.
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: 3.2.0
info:
title: Business 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: Business AI Settings
paths:
/v3/ai/business_ai_settings/{business_uid}:
get:
tags:
- Business AI Settings
operationId: getBusinessAiSettings
summary: Retrieve a BusinessAiSettings
description: '## Overview
Retrieve the AI settings of a business. Every known key is returned, with its default filled in for keys the business has never changed, so the response is the same whether or not the business has stored settings.
The business is resolved from the token - a staff member can only read the settings of their own business.
**Available for Staff tokens**'
parameters:
- name: business_uid
in: path
required: true
schema:
type: string
description: The unique identifier of the business (e.g., "biz_abc123")
example: biz_abc123
responses:
'200':
description: Business 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:
type: object
properties:
business_ai_settings:
title: BusinessAiSettings
description: Business-level AI settings, controlling which AI features a business allows. Evaluated independently of the packaging flags that make a feature available in the first place
type: object
properties:
uid:
type: string
description: The unique identifier of the settings record. Null while the business is still on the defaults and no record has been written for it yet (e.g., "bas_9f31c2", null)
nullable: true
readOnly: true
business_uid:
type: string
description: The unique identifier of the business these settings belong to (e.g., "biz_abc123")
readOnly: true
settings:
type: object
description: Every known AI setting key, with its default filled in for keys the business has never changed. Defaults differ per key
properties:
note_summary:
type: object
description: AI note summaries. While not allowed, no new note gets a summary and existing summaries are withheld from note responses. Speech-to-text on notes is unaffected
properties:
allow:
type: boolean
description: Whether AI note summaries are allowed for this business. Defaults to true (e.g., true, false)
default: true
required:
- allow
opted_in:
type: object
description: Whether the business has opted in to AI. A business with no stored record is treated as not opted in until it explicitly opts in
properties:
allow:
type: boolean
description: Whether the business has opted in to AI. Defaults to false (e.g., false, true)
default: false
required:
- allow
required:
- note_summary
- opted_in
required:
- uid
- business_uid
- settings
example:
uid: bas_9f31c2
business_uid: biz_abc123
settings:
note_summary:
allow: true
opted_in:
allow: false
example:
success: true
data:
business_ai_settings:
uid: bas_9f31c2
business_uid: biz_abc123
settings:
note_summary:
allow: true
opted_in:
allow: false
'401':
description: Unauthorized - missing or invalid token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: unauthorized
message: Unauthorized
'403':
description: Forbidden - the settings belong to another business
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: forbidden
message: You do not have access to these business AI settings
security:
- Bearer: []
put:
tags:
- Business AI Settings
operationId: updateBusinessAiSettings
summary: Update a BusinessAiSettings
description: '## Overview
Create or update the AI settings of a business. Keys left out of the request keep their stored value, and unknown keys are rejected.
The business is resolved from the token - a staff member can only update the settings of their own business.
**Available for Staff tokens holding the `account.settings.manage` permission**'
parameters:
- name: business_uid
in: path
required: true
schema:
type: string
description: The unique identifier of the business (e.g., "biz_abc123")
example: biz_abc123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessAiSettingsRequest'
responses:
'200':
description: Business 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:
type: object
properties:
business_ai_settings:
title: BusinessAiSettings
description: Business-level AI settings, controlling which AI features a business allows. Evaluated independently of the packaging flags that make a feature available in the first place
type: object
properties:
uid:
type: string
description: The unique identifier of the settings record. Null while the business is still on the defaults and no record has been written for it yet (e.g., "bas_9f31c2", null)
nullable: true
readOnly: true
business_uid:
type: string
description: The unique identifier of the business these settings belong to (e.g., "biz_abc123")
readOnly: true
settings:
type: object
description: Every known AI setting key, with its default filled in for keys the business has never changed. Defaults differ per key
properties:
note_summary:
type: object
description: AI note summaries. While not allowed, no new note gets a summary and existing summaries are withheld from note responses. Speech-to-text on notes is unaffected
properties:
allow:
type: boolean
description: Whether AI note summaries are allowed for this business. Defaults to true (e.g., true, false)
default: true
required:
- allow
opted_in:
type: object
description: Whether the business has opted in to AI. A business with no stored record is treated as not opted in until it explicitly opts in
properties:
allow:
type: boolean
description: Whether the business has opted in to AI. Defaults to false (e.g., false, true)
default: false
required:
- allow
required:
- note_summary
- opted_in
required:
- uid
- business_uid
- settings
example:
uid: bas_9f31c2
business_uid: biz_abc123
settings:
note_summary:
allow: true
opted_in:
allow: false
example:
success: true
data:
business_ai_settings:
uid: bas_9f31c2
business_uid: biz_abc123
settings:
note_summary:
allow: false
opted_in:
allow: false
'400':
description: Bad request - malformed request or unknown setting key
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: bad_request
message: 'Unknown AI setting key(s): ai_global. Allowed keys: note_summary, opted_in'
'401':
description: Unauthorized - missing or invalid token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: unauthorized
message: Unauthorized
'403':
description: Forbidden - the settings belong to another business, or the staff member lacks the account.settings.manage permission
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: forbidden
message: Insufficient permissions to manage business settings
security:
- Bearer: []
components:
schemas:
BusinessAiSettingsRequest:
type: object
properties:
settings:
type: object
description: Settings to change. Keys that are omitted keep their stored value
properties:
note_summary:
type: object
description: AI note summaries. While not allowed, no new note gets a summary and existing summaries are withheld from note responses. Speech-to-text on notes is unaffected
properties:
allow:
type: boolean
description: Whether AI note summaries are allowed for this business (e.g., true, false)
required:
- allow
opted_in:
type: object
description: Whether the business has opted in to AI. A business with no stored record is treated as not opted in until it explicitly opts in
properties:
allow:
type: boolean
description: Whether the business has opted in to AI (e.g., false, true)
required:
- allow
required:
- settings
example:
settings:
note_summary:
allow: false
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
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