Tone of voice

The brand voices of your workspace. Guidelines are included for voices your team created.

Endpoints

GET /v1/toneofvoice List tones of voice
GET /v1/toneofvoice/{id} Get a tone of voice

List tones of voice

GET api.app.typetone.ai/public/v1/toneofvoice

Authorization

X-API-Keyheaderrequired
Your workspace API key.

Response · 200

idstringrequired
Unique ID.
keystringrequired
Machine-readable name.
toneOfVoiceMetasarray of ToneOfVoiceToneOfVoiceMetaRelationshiprequired
The tone of voice per language, with guidelines when available.

Errors

401 Missing or invalid API key.
403 The workspace is not on a plan with API access.
404 The resource does not exist in this workspace.

curl "https://api.app.typetone.ai/public/v1/toneofvoice" \
  -H "X-API-Key: $TYPETONE_API_KEY"

import os
import requests

response = requests.get(
    "https://api.app.typetone.ai/public/v1/toneofvoice",
    headers={"X-API-Key": os.environ["TYPETONE_API_KEY"]},
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.app.typetone.ai/public/v1/toneofvoice", {
  headers: {
    "X-API-Key": process.env.TYPETONE_API_KEY,
  },
});
const data = await response.json();

Response · 200

[
  {
    "id": "cmuf2k8x10001ab12cd34ef56",
    "key": "professional",
    "toneOfVoiceMetas": [
      {
        "id": "cmuf2k8x10001ab12cd34ef56",
        "name": "Homepage audit",
        "languageKey": "NL",
        "description": "Brand guidelines and product facts.",
        "content": "Checked with legal: fix before Friday.",
        "toneOfVoiceId": "cmuf2k8x10001ab12cd34ef56"
      }
    ]
  }
]

Get a tone of voice

GET api.app.typetone.ai/public/v1/toneofvoice/{id}

Authorization

X-API-Keyheaderrequired
Your workspace API key.

Path parameters

idstringrequired
Unique ID.

Response · 200

idstringrequired
Unique ID.
keystringrequired
Machine-readable name.
toneOfVoiceMetasarray of ToneOfVoiceToneOfVoiceMetaRelationshiprequired
The tone of voice per language, with guidelines when available.

Errors

401 Missing or invalid API key.
403 The workspace is not on a plan with API access.
404 The resource does not exist in this workspace.
422 A parameter or the request body is invalid. detail says which.

curl "https://api.app.typetone.ai/public/v1/toneofvoice/cmuf2k8x10001ab12cd34ef56" \
  -H "X-API-Key: $TYPETONE_API_KEY"

import os
import requests

response = requests.get(
    "https://api.app.typetone.ai/public/v1/toneofvoice/cmuf2k8x10001ab12cd34ef56",
    headers={"X-API-Key": os.environ["TYPETONE_API_KEY"]},
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.app.typetone.ai/public/v1/toneofvoice/cmuf2k8x10001ab12cd34ef56", {
  headers: {
    "X-API-Key": process.env.TYPETONE_API_KEY,
  },
});
const data = await response.json();

Response · 200

{
  "id": "cmuf2k8x10001ab12cd34ef56",
  "key": "professional",
  "toneOfVoiceMetas": [
    {
      "id": "cmuf2k8x10001ab12cd34ef56",
      "name": "Homepage audit",
      "languageKey": "NL",
      "description": "Brand guidelines and product facts.",
      "content": "Checked with legal: fix before Friday.",
      "toneOfVoiceId": "cmuf2k8x10001ab12cd34ef56"
    }
  ]
}

Something unclear or missing? Tell us and we'll improve this page.