Voices

Retrieve voice by ID

Changed on

Retrieve a voice by ID

get/v1/tones/{toneId}

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/tones/{toneId}
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Path parameters

toneIdstring required
Example:ton_2ee766eaa4ef48e59da1d9602bfecf2d

The voice's unique ID

Response

Retrieve voice by ID

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "tone",
  "data": {
    "name": "It's-a me, Mario!",
    "value": "This voice is energetic, playful, and humorous, characterized by exclamations, wordplay, and a confident, charismatic character, with techniques including catchphrases, direct address, and hyperbole to engage and entertain the audience.",
    "settings": {
      "appVisibility": "visible"
    },
    "id": "ton_2ee766eaa4ef48e59da1d9602bfecf2d",
    "createdAt": "2023-09-21T15:38:00.474Z",
    "updatedAt": "2023-09-21T15:38:00.474Z",
    "appUrl": "https://app.jasper.ai/jasper-iq/brand-voice/ton_2ee766eaa4ef48e59da1d9602bfecf2d"
  }
}

Changes