Skip to content

Fin Agent Message

A message exchanged within a Fin Agent conversation.

authorstringrequired

The author that created the message. In conversation_metadata.history, only user and agent are accepted.

Enum:"user""agent""fin"
Example:"user"
bodystringrequired

The body of the message. Accepts both plain text and HTML format. For the message you send to Fin, this is the user's message. For an agent item in conversation_metadata.history, it is the agent's message. Fin's response is returned in the format set by response_format (HTML by default).

Example:"How can I see my account details?"
timestampstring, (date-time)

The timestamp when the message was created. Used to deduplicate messages sent within a 5 minute window. Ideally should include milliseconds for higher precision. Send timestamp or timestamp_ms; at least one is required. If you send both, timestamp_ms is used. On the top-level message, sending neither fails with a 422 error (message: timestamp_ms is required). In conversation_metadata.history, an item with neither causes the whole history to be ignored.

Example:"2025-01-24T10:01:20.000Z"
timestamp_msstring, (date-time)

The timestamp when the message was created, with millisecond precision. Accepted in place of timestamp when you send a message, and also present in event responses (fin_replied). At least one of timestamp or timestamp_ms is required.

Example:"2025-01-24T10:01:20.456Z"
{ "author": "user", "body": "How can I see my account details?", "timestamp": "2025-01-24T10:01:20.000Z", "timestamp_ms": "2025-01-24T10:01:20.456Z" }