JAjasper
Voices

Retrieve all voices

Changed on

Returns a list of voices available to your workspace, sorted from most recently created

get/v1/tones

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/tones
  • 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

Query parameters

qstring
Example:metadata[key]:value

You can use the q parameter to run a query parameter search. Query parameter search supports the following fields: name, metadata, and settings.

Supported operators: AND

The AND operator can be used to combine multiple search criteria.

NOTE: The AND operator supports a maximum of 10 operators

Available field examples:

name: value

metadata[key]:value

settings[appVisibility]:visible

metadata[key1]:value1 AND metadata[key2]:value2

pagenumber

The desired page number of voices

sizenumber

The number of voices per page to return in the response

Response

Retrieve voices

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

  • 3d5be7408661Revision changes
    • breaking

      the // response's property type changed from string to object for status

    • breaking

      the // response's property type changed from string to object for status

    • info

      added the optional property // to the response with the status