--- updatedAt: 2026-07-21T08:40:48.000Z agentTools: projectIndex: https://developers.intandem.tech/llms.txt --- # Get all BizAIChats ## Overview Get a list of all chat sessions. Available for **Staff, Directory, and Client tokens** # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Ai", "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" } ], "paths": { "/v3/ai/bizai_chats": { "get": { "operationId": "ChatsController_getChats", "summary": "Get all BizAIChats", "description": "## Overview\nGet a list of all chat sessions.\n\nAvailable 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": [] } ] } } }, "components": { "schemas": { "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}'" } } } } ```