Burn-in Caption¶
Burns the caption in the original media and send it to email. As the email is an optional argument if you do not provide it, the destination will be the email defined in your account.
HTTP Method
-
GET/api/job/burn_in_caption¶
Query String Parameters — Required
| Name | Details | |
|---|---|---|
| v | Description | The version of the API to use |
| Allowed Values | 1 | |
| Example | v=1 |
|
| api_token | Description | The API token used for this session |
| Allowed Values | Hex String | |
| Example | api_token=7ca5dc5c7cce449fb0fff719307e8f5f |
|
| job_id | Description | The ID of the job to be authorized |
| Allowed Values | Hex String | |
| Example | job_id=64bea283eff6475ea6596027a6ba0929 |
|
Query String Parameters — Optional
| Name | Details | |
|---|---|---|
| send_to_email | Email to send the burned-in caption media. |
|
| Allowed Values | String | |
| Default Value | Account email | |
| Example | send_to_email=user@email.com |
|
Responses
| HTTP Code | Details | |
|---|---|---|
| 200 | Description | Success |
| Contents | none | |
| 400 | Description | An error occurred |
| Contents | Error description (see Error Format for details) | |
Example Requests
GET /api/job/burn_in_caption?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&job_id=64bea283eff6475ea6596027a6ba0929 HTTP/1.1
Host: api.cielo24.com
GET /api/job/burn_in_caption?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&job_id=64bea283eff6475ea6596027a6ba0929&send_to_email=user%40email.com HTTP/1.1
Host: api.cielo24.com
Example Response
HTTP/1.1 200 OK