Skip to content

Issues ​

Issues are bug reports and feedback entries linked to specific conversations, sessions, or events within a project. They provide a structured way to track problems encountered during conversational AI interactions.

Structure ​

FieldTypeDescription
idintegerAuto-incrementing identifier
projectIdstringProject this issue belongs to
environmentstringDeployment environment (e.g., production, staging, development)
buildVersionstringApplication build version when the issue occurred
stagestring | nullStage identifier where the issue occurred
sessionIdstring | nullRelated conversation session ID
eventIndexinteger | nullIndex of the specific event in the session where the issue occurred
userIdstring | nullUser who reported or encountered the issue
severitystringSeverity level: critical, high, medium, low
categorystringIssue category: bug, feature, performance
bugDescriptionstringDetailed description of the issue
expectedBehaviourstringWhat the expected behavior should have been
commentsstringAdditional notes or context
statusstringCurrent status: open, in_progress, resolved, closed
createdAtdateCreation timestamp
updatedAtdateLast update timestamp

Linking to Conversations ​

Issues can be linked to specific points in a conversation through three optional fields:

  • sessionId — The WebSocket session ID of the conversation where the issue occurred
  • eventIndex — The specific event index within that session, allowing pinpoint identification of the problematic interaction
  • stage — The stage that was active when the issue occurred

This linkage enables support teams to replay the exact conversation state and context that led to the issue.

Severity Levels ​

SeverityDescription
criticalSystem-breaking issues affecting all users
highSignificant problems affecting user experience
mediumNotable issues with workarounds available
lowMinor issues or cosmetic problems

Status Lifecycle ​

Issues follow a standard status lifecycle:

open → in_progress → resolved → closed
StatusDescription
openNewly created, awaiting triage
in_progressActively being investigated or fixed
resolvedFix has been applied
closedIssue verified as resolved or dismissed

Use Cases ​

  • QA feedback — Testers report conversation flow issues with precise session/event references
  • Production monitoring — Automatically create issues when conversations encounter errors
  • User complaints — Track end-user reported problems back to specific conversation turns
  • Performance tracking — Log latency or quality issues tied to specific stages or builds

Common Operations ​

  • Create — POST /api/issues
  • List — GET /api/issues (with pagination, search, and filtering)
  • Get — GET /api/issues/:id
  • Update — PUT /api/issues/:id
  • Delete — DELETE /api/issues/:id

See the Issues API reference for full details.

Released under the Apache-2.0 License.