Get Template Details with Specified ID

You can only read your own templates. Someone else's template and a deleted template both return 404 RESOURCE_NOT_FOUND.

Voices in the returned contents are already in metaVoiceId index form (see the create-template description); map them back to real voiceId values before generating.

INFO

See the Errors document for the full code reference. Always use the X-Vocu-App-Request-Id response header when troubleshooting.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Template Details Retrieved Successfully

application/json

Template details

Bodyapplication/json

Example

{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "c9baa76f-de5f-4746-afbc-dffd4b9fb7ab",
        "name": "Gou Fang",
        "contents": [
            {
                "metaVoiceId": 44,
                "text": "Tender dog meat skewers, brushed with a sweet and spicy banana sauce, served over fragrant jasmine rice."
            }
        ],
        "metadata": {
            "metaVoiceId": 2,
            "description": "Template containing many food descriptions"
        },
        "userId": "a031f1b6-06e1-4bf7-bf06-3994ae08df25",
        "from": "community",
        "originId": "5b1fcba0-9dbe-4111-a177-f541356762b3"
    }
}

🟠401Unauthorized

🟠404Not found

🟠429Rate limited

Get Template Details with Specified ID

Request

Request Code Samples

Responses