Visit Later
N/a
General Notes
- Used when user wants to edit a widget — loads the conversation history to show in the chat panel
- Returns all messages including AI responses with their SQL and chartConfig
Flow
Test cases
Method & URL
GET v1/conversations/:conversationId
Request
Headers
authorization
- Required
- Type : <string>
- Bearer session token
Query
Body
Path parameter
conversationId
- Required
- Type : <string>
- The ID of the conversation
Response
2xx
success
- Type : true (boolean)
- This indicates that request was executed successfully
message
- Type : <string> | null
- Generic message
data
- Type : <object>
data.conversation
- Type : <object>
data.conversation.id
- Type : <string>
data.conversation.name
- Type : <string>
- AI-generated conversation name
data.conversation.status
- Type : <string>
- Enum : active | completed
data.conversation.widgetId
- Type : <string> | null
- Set once a widget has been generated
data.conversation.messages
- Type : <object>[]
data.conversation.messages[].role
- Type : <string>
- Enum : user | assistant
data.conversation.messages[].content
- Type : <string>
- Message text
data.conversation.messages[].sql
- Type : <string> | undefined
- Present on assistant messages that generated a widget
data.conversation.messages[].chartConfig
- Type : <object> | undefined
- Present on assistant messages that generated a widget
data.conversation.messages[].timestamp
- Type : <string>
- ISO date
404
success
- Type : false (boolean)
message
- Type : <string>
- Conversation not found