Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-01-138320.8 KB
Messages

Ingest API messages

Ingests an array of API messages for a project. Messages are validated and stored for later analysis.

Scope: messages:write
post/messages/{projectId}

Path parameters

projectIdstring required

Unique identifier of the project.

Example:cmk4s

Request body

threadIdstring required

Unique identifier of the thread. Commonly tied to a user.

typestring required

Original message's MIME Type.

direction'SENT' | 'RECEIVED' required

Indicates whether the message was sent by the agent or received from the user.

contentstring required

The actual content of the message.

agentIdstring required

An identifier for the agent the user is interacting with.

timestampstring date-time required

A timestamp representing when the message was sent or received (ISO 8601).

Example request

[
  {
    "threadId": "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
    "type": "text/plain",
    "direction": "SENT",
    "content": "My name is John Doe. How can I assist you?",
    "agentId": "support@waizer.ai",
    "timestamp": "2025-09-10T10:39:44.000Z",
    "metadata": {
      "error": "Failed to deliver message due to network error.",
      "humanAssigneeId": "john.doe@waizer.ai"
    }
  }
]

Response

Messages ingested successfully

messagestring required

Status message describing the result of the ingestion.

countnumber required

Number of messages successfully ingested.

Example response

{
  "message": "Messages ingested successfully",
  "count": 42
}
All 8 operations