About this endpoint
What it does
Submits an asynchronous job to generate a thank-you email from the provided content and optional generation settings. It returns a job identifier and a status URL that you can use to check when the email generation has finished.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| content | String | Yes | Product name and its parameters to generate the thank you Email. |
| context | String | No | An additional flexible instructions for content processing. |
| language | String | No | Specify the language of the output, defaults to English. |
| max_length | Number | No | Specify the maximum length of email in words. eg. 100 |
| voice_tone | String | No | Specify the voice tone of the output. It can be adjectives like funny or joyous, or even the name of a famous writer. |
Response
Returns a JSON object with two required string fields: job_id and status_url. job_id is a UUID identifying the submitted async job, and status_url is a URI for checking the job status.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| job_id | String | Yes | Identifier of the submitted asynchronous job. Format: UUID. |
| status_url | String | Yes | URL used to check the submitted job status. Format: URI. |
Notes
This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Extract job_id from the response and use it for polling.