Nuvion IQVisual Guide
An interactive visualization of the Nuvion IQ conversational AI interface. Understand the architecture, session lifecycle, and implementation patterns before diving into the full documentation.
Endpoints
Contexts
Max Message
Architecture Flow
Click on each component to explore its role in the Nuvion IQ system. Data flows through these components and back to deliver a seamless conversational experience.
Session Lifecycle
Watch the complete lifecycle of an IQ session from user message to API execution. Use the controls to step through or auto-play the flow.
User sends message
activeCreates or updates IQ session
Session marked 'processing'
Prevents duplicate messages
Message sent to LLM
With context (actions, fields)
LLM responds
Asks for missing information
Session marked 'active'
Ready for next user message
When complete โ 'ready'
Session has API payload
Frontend calls target API
Using the generated payload
Result displayed
To user in friendly format
Conversation Simulator
Experience a realistic IQ conversation flow. Click "Send Next Message" to step through a send-money conversation and see how the AI collects required information.
Nuvion IQ
Click "Send Next Message" to start the conversation
Session Status
active
Ready for user input
Collected Data
No data collected yet
API Endpoints
Explore the three main endpoints for interacting with Nuvion IQ sessions. All endpoints require JWT authentication.
Create IQ Session
Creates a new conversational session or continues an existing one
/iq-sessionsRequest
{
"session_reference": "01JEF8XYZ123456789ABCDEF_1733750400000",
"message": "I want to send money to John",
"context_code": "send-money"
}Response
200 OK{
"status": 200,
"message": "IQ session created successfully",
"data": {
"id": "01JEF8XYZ123456789ABCDEF",
"session_reference": "01JEF8XYZ123456789ABCDEF_1733750400000",
"messages": [
{
"sender": "user",
"text": "I want to send money to John"
},
{
"sender": "system",
"text": "I'd be happy to help you send money!..."
}
],
"status": "active"
}
}Auth Required: Authorization: Bearer <jwt_token>
Session Status States
Understanding session states is crucial for building a responsive UI. Each state requires different handling in your frontend implementation.
active
Green dot
Ready for next user message
Action: Allow user to type/send messages
processing
Animated dots
AI is thinking/responding
Action: Show loading indicator, disable input
ready
Action button
Payload ready for API call
Action: Extract payload, call target API
closed
Gray badge
Session ended by user
Action: Show session ended message
Status Check Implementation
// Check session status and handle accordingly
if (session.status === 'processing') {
showLoadingIndicator();
disableInput();
} else if (session.status === 'ready' && session.context.data.ready) {
const { endpoint, method, payload } = session.context.data;
await executeAPICall(endpoint, method, payload);
} else if (session.status === 'active') {
enableInput();
hideLoadingIndicator();
}Available Contexts
Nuvion IQ currently supports two action contexts. Each context defines what information the AI will collect and which API endpoint to call when complete.
Help users initiate bank transfers or mobile money payments
Required Fields
amountTransfer amount (number)currencyUSD, EUR, GHSnarrationPurpose/descriptionaccount_idSource account IDunique_referenceUnique payment referencecounterparty_id OR nuvion_banRecipient identifierOptional Fields
metadataAdditional informationsupporting_documentsDocument attachments