List Messages

List messages in the current workspace.

GET /api/v1/messages

List Messages

cURL

curl --request GET \
  --url https://api.example.com/api/v1/messages \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "conversation_id": "<string>",
      "sender_id": "<string>",
      "content": "<string>",
      "workspace_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "id": "<string>",
      "role": "user",
      "tool_calls": [
        {}
      ],
      "message_type": "text",
      "tags": [
        "<string>"
      ],
      "checksum": "<string>",
      "attachments": [
        {}
      ],
      "parent_message_id": "<string>",
      "meta_data": {},
      "sent_at": "2023-11-07T05:31:56Z",
      "owner_id": "<string>"
    }
  ],
  "total_count": 123,
  "page": 123,
  "limit": 123,
  "next_page": 123,
  "next_cursor": "<string>",
  "has_more": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Query Parameters

conversation_id · string | null

Filter by conversation ID

sender_id · string | null

Filter by sender ID

role · string | null

Filter by message role

message_type · string | null

Filter by message type

search · string | null

Search messages by content

tags · string | null

Filter by tags (comma-separated)

skip · integer · default: 0

Number of messages to skip

Required range: x >= 0

limit · integer · default: 100

Number of messages to return

Required range: 1 <= x <= 1000

order_by · string · default: created_at

Field to order by

order_direction · string · default: desc

Order direction (asc/desc)

Response

200

application/json

Successful Response

data · MessageRead · object[] · required

Show child attributes

total_count · integer · required

page · integer | null

limit · integer | null

next_page · integer | null

next_cursor · string | null

has_more · boolean | null