Jingles
Get a jingle generation request
GET
https://api.tunio.ai/Get the state of a jingle request. Once completed, jingle_id and audio_url point at the generated jingle in the caller's library; it stays there until deleted.
Path parameters
| Name | Type | Description |
|---|---|---|
| request_idRequired | string | Request ID |
Responses
| Name | Type | Description |
|---|---|---|
| request | object | - |
| audio_url | string | AudioURL is the CDN link to the jingle, set once completed. |
| completed_at | string | CompletedAt is when the jingle was generated. |
| cost | integer | Cost in credits: the estimate while pending or processing, the amount charged once completed. Nothing is charged for a failed request. |
| created_at | string | CreatedAt is when the request was accepted. |
| duration | integer | Duration of the jingle in seconds, set once completed. |
| end_pause_seconds | integer | EndPauseSeconds is the silence added at the end. |
| error | string | Error is a machine-readable failure code (insufficient_balance, processing_timeout, generation_failed), set only when state is failed. |
| generation_type | string | GenerationType is full, instrumental or voice. |
| jingle_id | string | JingleID is the generated jingle in the caller's library, set once completed; add it to a bundle with POST /v1/jingle-bundles/{bundle_id}/items. |
| model_id | string | ModelID is the voice the text is spoken with, null for instrumental. |
| music_duration | integer | MusicDuration is the requested music length for instrumental jingles. |
| request_id | string | RequestID uniquely identifies the request. |
| state | string | State is pending, processing, completed or failed. |
| style_prompt | string | StylePrompt describes the music bed. |
| text | string | Text is what the voice says. |
| title | string | Title is the generated jingle's title, set once completed. |
| voice_effect | string | VoiceEffect is none or telephone. |
| success | boolean | - |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |