Tone API icon

Tone API

Analyze tone, detect emotions, and rewrite text using the Tone API

Reply

AI-generated

Summary

Generate a reply to a given message using a specified role and tone, optionally including context to tailor the reply.

Inputs

  • Message (required) — The original message text to generate a reply for (up to 10,000 characters).
  • Role (required) — The persona or role to use when generating the reply, such as Support, Sales, HR, Executive, or Community.
  • Tone (required) — The tone to apply in the reply, selectable from Professional, Empathetic, Friendly, Assertive, or Casual.
  • Context — Optional additional context (e.g., order number, customer status) to generate a more relevant and accurate reply.

Output shape

a single JSON object per input item containing the generated reply from the Tone API

Each output item corresponds one-to-one with each input item. If an error occurs and 'continueOnFail' is enabled, the item will contain an error message instead of a reply.

Examples

Example 1: Generating a customer support reply with an empathetic tone

Provide the original customer message under 'Message', select 'Support' as Role, choose 'Empathetic' for Tone, and optionally include relevant order context under Context.

Links

Discussion