Skip to main content
Get Message By Id
curl --request GET \
  --url https://{api_endpoint}/api/v1/threads/{thread_id}/messages/{message_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "<string>",
  "created_by": "<string>",
  "created_by_username": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistant": {
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assistant_name": "<string>",
    "is_default": false
  },
  "parent_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "content": [
    {
      "response_type": "conversational_search",
      "json_schema": {},
      "ui_schema": {},
      "form_data": {},
      "id": "<string>",
      "form_operation": "<string>",
      "sub_type": "<string>",
      "event_type": "<string>",
      "dps_payload_id": "<string>"
    }
  ],
  "mentions": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "document_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "additional_properties": {
    "wxa_message": {},
    "display_properties": {
      "skip_render": false,
      "is_async": false,
      "form_operation": ""
    },
    "tool_calls": [
      {}
    ],
    "tool_call_id": "<string>",
    "tool_name": "<string>",
    "wxo_connection_status": {
      "connection_status": "<string>",
      "connection_message": "<string>"
    }
  },
  "context": {},
  "step_history": [
    {}
  ],
  "message_state": {}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

thread_id
string
required
message_id
string
required

Response

Successful Response

id
string<uuid>
required
tenant_id
string
required
thread_id
string<uuid>
required
assistant
object
required
role
string
required
content
AssistantContent · object[]
required
created_by
string | null
created_by_username
string | null
created_on
string<date-time> | null
updated_at
string<date-time> | null
parent_message_id
string<uuid> | null
mentions
Mentions · array
  • Mention
  • AssistantMention
document_ids
string<uuid>[] | null
additional_properties
object | null
context
object | null
step_history
Step History · object[] | null
message_state
object | null