La référence de l'API est publiée en anglais.

Explicitly send email: start a child task or reply to a bound conversation

POST/api/companies/{companyId}/email/send
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Explicitly send email: start a child task or reply to a bound conversation.

AgentMail email connection. Available without the experimental chat setting. Internal comments never send email. Agent sends require assigned inbox and task ownership, active run authority, and configured action policies. Preserve the same idempotencyKey and payload across retries. New conversations create an email child task; replies require conversationId and replyToMessageId. Reply-all is deliberate and never includes Bcc.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Autorisation

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.

Paramètres de chemin

companyIdstring (uuid)ObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

endpointIdstring (uuid)Obligatoire
parentIssueIdstring (uuid)Facultatif
conversationIdstring (uuid)Facultatif
replyToMessageIdstringFacultatif1–998 characters
replyAllbooleanFacultatif
toarray<string (email)>Facultatifeach at most 320 characters
ccarray<string (email)>Facultatifeach at most 320 characters
bccarray<string (email)>Facultatifeach at most 320 characters
subjectstringFacultatif1–998 characterspattern: ^[^\r\n]+$
textstringObligatoire1–100000 characters
attachmentIdsarray<string (uuid)>Facultatif
idempotencyKeystring (uuid)Obligatoire

Réponses

202SuccessAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Email