Skip to content

Draft many emails in one call

POST
/voice/email-agent/batch

SPENDS CREDITS, once per email. Composes and/or drafts replies in parallel; results come back per item even when some fail. Writes, does NOT send.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Voice BatchEmailProcessingRequest, without org_id / agent_settings.

object
agent_id
required
string
>= 1 characters
contact_id
required
string
>= 1 characters
emails
required
Array<object>
>= 1 items <= 50 items

Voice BatchEmailRequest: one compose or respond job inside a batch.

object
context
Any of:
string
email_to_respond_body
Any of:
string
email_to_respond_subject
Any of:
string
email_type
Any of:
string
recipient_info
Any of:
string
response_type
Any of:
string
sender_info
Any of:
string
thread_emails
Any of:
Array<object>

Voice EmailThread: one earlier message in the thread being answered.

object
body
required
string
sender
Any of:
string
subject
required
string
timestamp
Any of:
string
thread_id
Any of:
string
type
required

Compose a new email, or respond to one.

string
Allowed values: compose respond
model

Openai: gpt-4o or gpt-4o-mini. anthropic: claude-sonnet-4-6, claude-haiku-4-5-20251001 or claude-opus-4-6. Voice rejects any other pairing with a 422.

string
default: gpt-4o
provider

LLM provider.

string
default: openai
Allowed values: openai anthropic openrouter

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string