RoboConnect Developer Docs

Chatbot API Documentation v1

Complete reference for the RoboConnect chatbot API, including live testing, session status, reports, final submission, database check, and UI metadata for future smart frontend controls.

Used by Swagger “Try it out” and the quick tester below.

Quick Test Console

Use this to test the session-based chatbot quickly. Requests are sent with credentials enabled so PHP sessions work across calls. 

No request sent yet.

How The Chat Flow Works

Session Based

The API uses PHP sessions. Keep browser cookies enabled and call the API with credentials so the server knows which answers belong to the same user.

Structured Data

The chatbot collects company profile fields in order, validates each answer, then returns a summary and stores the final submission when complete.

Frontend UI Metadata

Every chat response includes current_field, section, ui.kind, and optional ui.options so the frontend can render text inputs, selects, phone controls, revenue controls, and future widgets.

Important Response Fields

answer
Human-readable chatbot reply to show in the conversation.
current_field
Stable field key the frontend can use to render a matching control.
ui.kind
Recommended frontend input type, such as text, email, phone, single_select, address, or revenue.
data
All company data collected so far for the current PHP session.
status.progress
Counts completed fields and lists remaining fields in the current section.