Skip to main content

This is a Custom Schema Page Generated by docusaurus-openapi-docs using schema.mustache template



Session

A chat session between a user and an assistant

idstring

Session ID (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011
tenantIdstring

Tenant ID

Example: 507f1f77bcf86cd799439012
assistantIdstring

Assistant ID

Example: 507f1f77bcf86cd799439013
systemIdstring

System ID

Example: 507f1f77bcf86cd799439014
inputMessagestring

User's input message

Example: Hello, can you help me with my project?
outputstring

Assistant's final response

Example: I'd be happy to help you with your project!
historyobject[]

Execution history and intermediate steps

errorstring

Error message if the session failed

statusstring

Session status

Example: completed
createdAtstring<date-time>

Creation timestamp

Example: 2023-12-01T10:30:00.000Z
updatedAtstring<date-time>

Last update timestamp

Example: 2023-12-01T15:45:00.000Z
property name*any

A chat session between a user and an assistant



This is a Custom Schema Page Generated by docusaurus-openapi-docs using schema.mustache template

Session
{
  "id": "507f1f77bcf86cd799439011",
  "tenantId": "507f1f77bcf86cd799439012",
  "assistantId": "507f1f77bcf86cd799439013",
  "systemId": "507f1f77bcf86cd799439014",
  "inputMessage": "Hello, can you help me with my project?",
  "output": "I'd be happy to help you with your project!",
  "history": [
    {}
  ],
  "error": "string",
  "status": "completed",
  "createdAt": "2023-12-01T10:30:00.000Z",
  "updatedAt": "2023-12-01T15:45:00.000Z"
}