Get Chat Messages

GET 
/api/chat/messages

This endpoint retrieves messages from a specified conversation within a workspace. The request must include a valid API key and user ID.

Request

Query Parameters

workspaceId stringrequired

ID of the workspace whose conversations are being retrieved.

conversationId stringrequired

ID of the conversation whose messages are being retrieved.

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

Responses

200

Successfully retrieved chat messages.

application/json

Schema

Schema

data

object[]

Array [

query string

The query from the conversation.

type string

The type of the message (query or response).

queryresponseid string

The ID of the query response.

createdat date-time

The timestamp when the message was created.

name string

The name of the conversation.

ownerid string

The ID of the owner of the conversation.

followUps

object[]

Array [

id string

The ID of the follow-up question.

text string

The text of the follow-up question.

]

sourceSnips

object[]

Array [

id string

The ID of the source snippet.

text string

The text of the source snippet.

]

]

Example (from schema)

{
  "data": [
    {
      "query": "string",
      "type": "string",
      "queryresponseid": "string",
      "createdat": "2024-12-12T17:23:19.621Z",
      "name": "string",
      "ownerid": "string",
      "followUps": [
        {
          "id": "string",
          "text": "string"
        }
      ],
      "sourceSnips": [
        {
          "id": "string",
          "text": "string"
        }
      ]
    }
  ]
}

400

Invalid query parameters.

application/json

Schema

Schema

error string

Error message indicating that there was an issue with the query parameters.

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...