Carbon

Agent Message

The agent message resource.

Basehttps://rest.carbon.ms/agentMessage
GET/agentMessage

List agent messages

Retrieve a paginated list of agent messages. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/agentMessage
curl --request GET \
  --url 'https://rest.carbon.ms/agentMessage?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "threadId": "xyz789",
    "role": "string",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "context": "string",
    "feedback": "string"
  }
]
GET/agentMessage

Retrieve a agent message

Fetch a single agent message by filtering on `id`.

Query parameters

idstring

Match on the agent message's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/agentMessage
curl --request GET \
  --url 'https://rest.carbon.ms/agentMessage?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "threadId": "xyz789",
  "role": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "context": "string",
  "feedback": "string"
}
POST/agentMessage

Create a agent message

Create a new agent message.

Body parameters

threadIdstringrequired
rolestringrequired
contextobject
feedbackstring
feedbackNotestring
finishReasonstring
inputTokensnumber
outputTokensnumber
POSThttps://rest.carbon.ms/agentMessage
curl --request POST \
  --url https://rest.carbon.ms/agentMessage \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"threadId":"xyz789","role":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "threadId": "xyz789",
  "role": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "context": "string",
  "feedback": "string"
}
PATCH/agentMessage

Update a agent message

Update an existing agent message, matched on `id`.

Body parameters

threadIdstringrequired
rolestringrequired
contextobject
feedbackstring
feedbackNotestring
finishReasonstring
inputTokensnumber
outputTokensnumber
PATCHhttps://rest.carbon.ms/agentMessage
curl --request PATCH \
  --url 'https://rest.carbon.ms/agentMessage?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"threadId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "threadId": "xyz789",
  "role": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "context": "string",
  "feedback": "string"
}
DELETE/agentMessage

Delete a agent message

Delete a agent message, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the agent message to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/agentMessage
curl --request DELETE \
  --url 'https://rest.carbon.ms/agentMessage?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content