Ottieni le impostazioni dell'account

curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/settings_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "companyName": "Studio",
    "brandVocabulary": [
      "VoiceCheap"
    ],
    "customTranslationInstructions": "Keep product names unchanged.",
    "canEditSharedSettings": true,
    "favoriteTemplates": {
      "dynamicSubtitles": null,
      "voiceIds": []
    },
    "targetLanguagePresets": [
      {
        "id": "european_languages",
        "name": "European languages",
        "languages": [
          "french",
          "german"
        ]
      }
    ],
    "socialMediaStatsPresets": [],
    "textToSpeechBrandPresets": [],
    "defaultVoiceCloningSettings": {
      "stability": 0.5,
      "similarity": 0.75
    },
    "isSoundNotificationsEnabled": true,
    "isVoiceCloningSettingsTipDismissed": false
  }
}

POST

actions

settings_get

curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/settings_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "companyName": "Studio",
    "brandVocabulary": [
      "VoiceCheap"
    ],
    "customTranslationInstructions": "Keep product names unchanged.",
    "canEditSharedSettings": true,
    "favoriteTemplates": {
      "dynamicSubtitles": null,
      "voiceIds": []
    },
    "targetLanguagePresets": [
      {
        "id": "european_languages",
        "name": "European languages",
        "languages": [
          "french",
          "german"
        ]
      }
    ],
    "socialMediaStatsPresets": [],
    "textToSpeechBrandPresets": [],
    "defaultVoiceCloningSettings": {
      "stability": 0.5,
      "similarity": 0.75
    },
    "isSoundNotificationsEnabled": true,
    "isVoiceCloningSettingsTipDismissed": false
  }
}

Ottieni il vocabolario salvato, le istruzioni di traduzione, le impostazioni predefinite di voce e lingua, i modelli preferiti e le preferenze personali dell’interfaccia.

POST https://api.voicecheap.ai/v1/actions/settings_get

Autenticazione e autorizzazioni

string

obbligatorio

Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth sono accettati solo da MCP, non da questo endpoint REST.

Autorizzazioni richieste: settings:read. È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.

Parametri

Invia un oggetto JSON vuoto. Questa azione non ha campi di input.

Schema di input completo

Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull’operazione.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Esempi di richiesta

Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l’identificatore della richiesta quando ripeti la stessa modifica.

curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/settings_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

Risposta

Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell’operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L’esempio mostra una risposta supportata, non tutti i campi facoltativi. Restituisce le preferenze personali del chiamante e il vocabolario condiviso e le istruzioni di traduzione del proprietario dell’area di lavoro attiva.

{
  "data": {
    "companyName": "Studio",
    "brandVocabulary": [
      "VoiceCheap"
    ],
    "customTranslationInstructions": "Keep product names unchanged.",
    "canEditSharedSettings": true,
    "favoriteTemplates": {
      "dynamicSubtitles": null,
      "voiceIds": []
    },
    "targetLanguagePresets": [
      {
        "id": "european_languages",
        "name": "European languages",
        "languages": [
          "french",
          "german"
        ]
      }
    ],
    "socialMediaStatsPresets": [],
    "textToSpeechBrandPresets": [],
    "defaultVoiceCloningSettings": {
      "stability": 0.5,
      "similarity": 0.75
    },
    "isSoundNotificationsEnabled": true,
    "isVoiceCloningSettingsTipDismissed": false
  }
}

Campi del risultato

Campo	Descrizione
`data.companyName`	Nome dell’azienda personale, oppure null.
`data.brandVocabulary`	Vocabolario condiviso del proprietario dell’area di lavoro; un array vuoto indica che non è presente alcun termine.
`data.customTranslationInstructions`	Istruzioni di traduzione condivise dell’account; una stringa vuota indica che non sono presenti istruzioni.
`data.canEditSharedSettings`	Indica se il chiamante può modificare il vocabolario condiviso e le istruzioni di traduzione.
`data.favoriteTemplates`	Preferiti salvati per sottotitoli e voci, oppure null.
`data.favoriteTemplates.dynamicSubtitles`	Nome del modello di sottotitoli dinamici preferito, oppure null.
`data.favoriteTemplates.voiceIds`	Identificatori delle voci preferite.
`data.targetLanguagePresets`	Preset linguistici personali salvati.
`data.targetLanguagePresets[].id`	Identificatore del preset.
`data.targetLanguagePresets[].name`	Nome visualizzato della preimpostazione.
`data.targetLanguagePresets[].languages`	Lingue salvate in quella preimpostazione.
`data.socialMediaStatsPresets`	Selezioni personali salvate dei canali.
`data.socialMediaStatsPresets[].channelIds`	Identificatori dei canali salvati in quella preimpostazione.
`data.textToSpeechBrandPresets`	Preimpostazioni espressive personali salvate per la sintesi vocale.
`data.textToSpeechBrandPresets[].voice`	Identificatore salvato di selezione della voce.
`data.textToSpeechBrandPresets[].instructionPreset`	Nome della preimpostazione espressiva salvata.
`data.textToSpeechBrandPresets[].instructions`	Istruzioni espressive salvate.
`data.textToSpeechBrandPresets[].speed`	Moltiplicatore salvato della velocità del parlato.
`data.defaultVoiceCloningSettings`	Valori predefiniti di stability e similarity, oppure null.
`data.isSoundNotificationsEnabled`	Preferenza personale per le notifiche sonore.
`data.isVoiceCloningSettingsTipDismissed`	Indica se il chiamante ha chiuso il suggerimento sulle impostazioni vocali.

Note sull’operazione

Quando l’account è membro di un team, le impostazioni condivise provengono dal proprietario del team, mentre le preferenze dell’interfaccia rimangono personali.

Utilizzo

Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell’operazione.

Errori

Stato HTTP	Codice	Significato o risoluzione
400	`CREDENTIAL_IN_QUERY`	Le credenziali sono state fornite in un parametro di query access_token o api_key. Invia le credenziali negli header.
400	`VALIDATION_ERROR`	L’oggetto JSON contiene un campo non supportato, un valore non valido o un argomento obbligatorio mancante.
401	`API_KEY_EXPIRED`	La chiave API è scaduta.
401	`INVALID_API_KEY`	Fornisci una chiave API valida e non scaduta.
401	`INVALID_CREDENTIAL`	L’header Authorization non è valido oppure è in conflitto con x-api-key.
401	`MISSING_CREDENTIAL`	Non è stata fornita alcuna credenziale utilizzabile negli header, oppure la credenziale superava 4096 caratteri.
401	`USER_NOT_FOUND`	L’account associato alla credenziale non esiste più.
403	`AMBIGUOUS_TEAM_API_KEY`	L’utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo.
403	`INSUFFICIENT_SCOPE`	Concedi tutte le autorizzazioni richieste o scegli un’altra credenziale.
403	`INTEGRATION_PLAN_UNSUPPORTED`	Impossibile verificare i limiti di integrazione dell’account.
403	`SUBSCRIPTION_REQUIRED`	Usa un abbonamento a pagamento attivo.
403	`TEAM_MEMBERSHIP_INVALID`	L’appartenenza attuale dell’account al team non corrisponde all’area di lavoro di questa connessione. Aggiorna l’appartenenza e riconnettiti.
403	`TEAM_OWNER_NOT_FOUND`	Non è stato possibile trovare l’account effettivo del proprietario del team.
404	`ACCOUNT_NOT_FOUND`	Non è stato possibile trovare l’account o l’account dell’area di lavoro attiva.
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	Attendi il ripristino mensile o cambia piano.
429	`INTEGRATION_RATE_LIMIT_REACHED`	Rispetta Retry-After quando presente e applica attese crescenti tra i tentativi.
500	`INTERNAL_ERROR`	Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica.
503	`SERVER_RESTARTING`	Il server si sta riavviando. Riprova tra poco e mantieni lo stesso identificatore della richiesta per una modifica.

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["settings:read"]
  }
}

Panoramica

Discovery

Account

Utilizzo e attività

Impostazioni e notifiche

Team

Progetti

Traduzione e doppiaggio

Trascrizioni e modifica

Sintesi vocale

Voci per la sintesi vocale

Voci per il doppiaggio

Trascrizione

Sottotitoli e didascalie

Immagini

Miniature

Cartelle

Glossario

Webhook

Pubblicazione

Stato delle richieste

OAuth e protocollo MCP

Autenticazione e autorizzazioni

Parametri

Esempi di richiesta

Risposta

Campi del risultato

Note sull’operazione

Utilizzo

Errori

​Autenticazione e autorizzazioni

​Parametri

​Esempi di richiesta

​Risposta

​Campi del risultato

​Note sull’operazione

​Utilizzo

​Errori

Autenticazione e autorizzazioni

Parametri

Esempi di richiesta

Risposta

Campi del risultato

Note sull’operazione

Utilizzo

Errori