VBAssist

Processes a chat message from a user and returns a response from the VBAssist AI. Advanced API

Sends a user message to the VBAssist AI service and returns the generated response. Supports conversation tracking through agent_id and conversation_id parameters.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:

The request object containing the user's message and optional conversation tracking information.

message
string or null

The message text entered by the user to be processed by the AI. Contains the question, statement, or request that requires a response.

agent_id
string or null

The unique identifier for the AI agent handling this conversation. Used for tracking which AI model or version processed the request. If not provided, the system will use a default agent ID.

conversation_id
string or null

The unique identifier for the ongoing conversation between user and AI. Allows the system to maintain context across multiple message exchanges. If not provided, the system will treat this as a new conversation.

Responses
200

Success - Returns the AI-generated response

401

Unauthorized

post/chat/inquiry
Request samples
{
  • "message": "string",
  • "agent_id": "string",
  • "conversation_id": "string"
}
Response samples
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}

Submits user feedback about a previous chat interaction with the VBAssist AI. Advanced API

Records user feedback about a specific conversation with VBAssist, including a numerical rating (1-5) and textual comments. Requires conversation and agent identifiers.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:

The feedback details including rating, comments, and conversation identifiers.

agent_id
required
string non-empty

The unique identifier of the AI agent that handled the conversation. This is required to track which agent received the feedback.

conversation_id
required
string non-empty

The unique identifier of the conversation for which feedback is being provided. This links the feedback to a specific chat interaction in the system.

rating
required
integer <int32> [ 1 .. 5 ]

Numeric rating given to the conversation quality. Typically represents user satisfaction level with the AI response. Must be a value between 1 and 5, where 1 is lowest satisfaction and 5 is highest.

feedback
required
string non-empty

Textual feedback provided by the user about the conversation. Contains detailed comments, suggestions, or issues reported by the user.

Responses
200

Success - Feedback submitted successfully

401

Unauthorized

post/chat/feedback
Request samples
{
  • "agent_id": "string",
  • "conversation_id": "string",
  • "rating": 1,
  • "feedback": "string"
}
Response samples
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}