v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Message

Get a message by its ID

Quickly get the full object for a given message. From the message, you can get the topic and all messages which exist on that topic.

get/api/message/{message_id}

Path parameters

message_idstring uuid required

The ID of the message to get.

Headers

TR-Datasetstring uuid required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Response

Message with the given ID

completion_tokensinteger nullable

contentstring required

created_atstring date-time required

dataset_idstring uuid required

deletedboolean required

idstring uuid required

prompt_tokensinteger nullable

rolestring required

sort_orderinteger required

topic_idstring uuid required

updated_atstring date-time required

Example response

{
  "completion_tokens": 300,
  "content": "Hello, world!",
  "created_at": "2021-01-01 00:00:00.000",
  "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "deleted": false,
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "prompt_tokens": 300,
  "role": "user",
  "sort_order": 1,
  "topic_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "updated_at": "2021-01-01 00:00:00.000"
}