Send Chat Message

POST 
/api/chat/message

This endpoint sends a message to a specified conversation within a workspace. The request must include a valid API key and user ID.

Request

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

application/json

Body

required

workspaceId stringrequired

ID of the workspace.

conversationId stringrequired

ID of the conversation.

message string

The message to be sent.

agentId string

ID of the agent, if applicable. Example - agenframe

disableMemory boolean

Flag to disable memory usage.

isFirst boolean

Indicates if this is the first message in the conversation.

Responses

200

Successfully sent the message and retrieved follow-up questions and source snippets.

application/json

Schema

Schema

data

object

id string

The ID of the response.

query string

The query that was sent.

agentid stringnullable

ID of the agent if applicable.

createdat date-time

Timestamp when the response was created.

dislikes string[]

likes string[]

rootAgentName string

Name of the root agent handling the query.

stepsBreakdown

object[]

Array [

agentname string

Name of the agent handling the step.

content object

Content and responses from the agent.

external string

External source used for the step.

step_id string

Unique identifier for the step.

type string

Type of step (e.g., 'rag').

]

suggested_files string[]nullable

followUps

object

id string

Unique identifier for the follow-up group.

questions string[]

sourceSnips

object[]

Array [

chunkid string

ID of the source chunk.

content string

Extracted content snippet.

displaytext string

Short preview of the snippet.

filename string

Name of the source file.

filetype string

Type of the source file.

url string

URL of the source document.

]

type string

The type of the message, which is 'response'.

Example (from schema)

{
  "data": {
    "id": "string",
    "query": "string",
    "agentid": "string",
    "createdat": "2025-02-05T11:57:14.187Z",
    "dislikes": [
      "string"
    ],
    "likes": [
      "string"
    ],
    "rootAgentName": "string",
    "stepsBreakdown": [
      {
        "agentname": "string",
        "content": {},
        "external": "string",
        "step_id": "string",
        "type": "string"
      }
    ],
    "suggested_files": [
      "string"
    ],
    "followUps": {
      "id": "string",
      "questions": [
        "string"
      ]
    },
    "sourceSnips": [
      {
        "chunkid": "string",
        "content": "string",
        "displaytext": "string",
        "filename": "string",
        "filetype": "string",
        "url": "string"
      }
    ],
    "type": "string"
  }
}

400

Invalid body or fetch operation failed.

application/json

Schema

Schema

error string

Error message indicating the issue with the request body or fetch operation.

Example (from schema)

{
  "error": "string"
}

403

Invalid API key.

application/json

Schema

Schema

error

object

message string

Detailed error message indicating that the API key is invalid.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

Conversation or workspace not found.

application/json

Schema

Schema

error

object

message string

Error message indicating that the conversation or workspace was not found.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

500

Internal server error.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...