Kontoeinstellungen aktualisieren

curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_update' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","brandVocabulary":["VoiceCheap"],"customTranslationInstructions":"Keep product names unchanged.","isSoundNotificationsEnabled":true}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  brandVocabulary: ['VoiceCheap'],
  customTranslationInstructions: 'Keep product names unchanged.',
  isSoundNotificationsEnabled: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_update', {
  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_update",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "brandVocabulary": ["VoiceCheap"], "customTranslationInstructions": "Keep product names unchanged.", "isSoundNotificationsEnabled": True},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "updated": true
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

POST

actions

settings_update

curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_update' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","brandVocabulary":["VoiceCheap"],"customTranslationInstructions":"Keep product names unchanged.","isSoundNotificationsEnabled":true}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  brandVocabulary: ['VoiceCheap'],
  customTranslationInstructions: 'Keep product names unchanged.',
  isSoundNotificationsEnabled: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_update', {
  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_update",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "brandVocabulary": ["VoiceCheap"], "customTranslationInstructions": "Keep product names unchanged.", "isSoundNotificationsEnabled": True},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "updated": true
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

Aktualisieren Sie unterstützte persönliche Einstellungen. Nur der Teameigentümer kann gemeinsames Vokabular und gemeinsame Übersetzungsanweisungen ändern. Nicht angegebene Einstellungen bleiben unverändert.

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

Authentifizierung und Berechtigungen

string

erforderlich

Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt. OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.

Erforderliche Berechtigungen: settings:write. Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

Parameter

string

An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.Format: “uuid”. Muster: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.

string

Textwert.Mindestlänge: 1. Höchstlänge: 120.

array

Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.Höchstanzahl an Elementen: 1000.

string

Textwert.Höchstlänge: 500.

union

Akzeptiert die im vollständigen Eingabeschema aufgeführten Alternativen.

array

Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.Höchstanzahl an Elementen: 50.

array

Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.Höchstanzahl an Elementen: 10.

object

JSON-Objekt. Die verschachtelten Felder finden Sie im vollständigen Eingabeschema.

boolean

Boolescher Wert.

boolean

Boolescher Wert.

Vollständiges Eingabeschema

Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

{
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
    },
    "companyName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "brandVocabulary": {
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 500
      }
    },
    "customTranslationInstructions": {
      "type": "string",
      "maxLength": 500
    },
    "favoriteTemplates": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "dynamicSubtitles": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "Sara",
                    "Daniel",
                    "Dan 2",
                    "Hormozi 4",
                    "Dan",
                    "Devin",
                    "Tayo",
                    "Ella",
                    "Tracy",
                    "Luke",
                    "Hormozi 1",
                    "Hormozi 2",
                    "Hormozi 3",
                    "Hormozi 5",
                    "Leon",
                    "Ali",
                    "Beast",
                    "Maya",
                    "Karl",
                    "Iman",
                    "Umi",
                    "David",
                    "Noah",
                    "Gstaad",
                    "Malta",
                    "Nema",
                    "Seth",
                    "William"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "voiceIds": {
              "anyOf": [
                {
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 256
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "targetLanguagePresets": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "languages": {
            "minItems": 1,
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 2,
              "maxLength": 64
            }
          }
        },
        "required": ["id", "name", "languages"],
        "additionalProperties": false
      }
    },
    "socialMediaStatsPresets": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "channelIds": {
            "minItems": 1,
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[^/]+$"
            }
          }
        },
        "required": ["id", "name", "channelIds"],
        "additionalProperties": false
      }
    },
    "textToSpeechBrandPresets": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60
          },
          "voice": {
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "instructionPreset": {
            "type": "string",
            "enum": ["default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic"]
          },
          "instructions": {
            "type": "string",
            "maxLength": 300
          },
          "speed": {
            "type": "number",
            "minimum": 0.5,
            "maximum": 2
          }
        },
        "required": ["id", "name", "voice", "instructionPreset", "instructions", "speed"],
        "additionalProperties": false
      }
    },
    "defaultVoiceCloningSettings": {
      "type": "object",
      "properties": {
        "stability": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "similarity": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        }
      },
      "required": ["stability", "similarity"],
      "additionalProperties": false
    },
    "isSoundNotificationsEnabled": {
      "type": "boolean"
    },
    "isVoiceCloningSettingsTipDismissed": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Idempotenz

Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet. Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.

Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_update' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","brandVocabulary":["VoiceCheap"],"customTranslationInstructions":"Keep product names unchanged.","isSoundNotificationsEnabled":true}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  brandVocabulary: ['VoiceCheap'],
  customTranslationInstructions: 'Keep product names unchanged.',
  isSoundNotificationsEnabled: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_update', {
  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_update",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "brandVocabulary": ["VoiceCheap"], "customTranslationInstructions": "Keep product names unchanged.", "isSoundNotificationsEnabled": True},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

Antwort

Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Bestätigt, dass die übergebenen unterstützten Einstellungen gespeichert wurden.

{
  "data": {
    "updated": true
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

Ergebnisfelder

Feld	Beschreibung
`data.updated`	true nach Abschluss der Einstellungsaktualisierung.

Diese Anfrage wiederherstellen und abfragen

Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.

curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"settings_update"}'

HTTP 200

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "settings_update",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "updated": true
    }
  }
}

Hinweise zur Operation

Geben Sie zusätzlich zur optionalen requestId mindestens eine Einstellung an. Nicht angegebene Einstellungen bleiben unverändert.
Nur der Teaminhaber kann brandVocabulary und customTranslationInstructions ändern. Teammitglieder können ihre eigenen übrigen Einstellungen aktualisieren.
Das Vokabular akzeptiert bis zu 1,000 Begriffe. Jeder normalisierte Begriff darf höchstens 49 Zeichen und fünf Wörter enthalten, ohne eckige, geschweifte oder spitze Klammern oder umgekehrte Schrägstriche. Doppelte Begriffe werden unabhängig von der Groß- und Kleinschreibung entfernt.
Firmennamen enthalten 1–120 Zeichen. Übersetzungsanweisungen des Kontos enthalten höchstens 500 Zeichen.
Sprach- und Kanalvoreinstellungen erlauben bis zu 50 Voreinstellungen mit jeweils 1–50 ausgewählten Sprachen oder Kanälen. Markenvoreinstellungen für die Sprachausgabe erlauben bis zu 10 eindeutige IDs, Namen mit 60 Zeichen, Anweisungen mit 300 Zeichen und eine speed von 0.5 bis 2.

Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

Fehler

HTTP-Status	Code	Bedeutung oder Behebung
400	`CREDENTIAL_IN_QUERY`	Zugangsdaten wurden in einem Abfrageparameter namens access_token oder api_key übergeben. Senden Sie Zugangsdaten in Headern.
400	`IDEMPOTENCY_CONFLICT`	Der Header Idempotency-Key und das Feld requestId im Anfragetext müssen übereinstimmen.
400	`INVALID_BRAND_VOCABULARY`	Ein oder mehrere Vokabularbegriffe entsprechen nicht den Regeln für Begriffslänge, Wortanzahl oder Zeichen.
400	`INVALID_REQUEST_ID`	Geben Sie eine UUID v4 als requestId oder Idempotency-Key an.
400	`VALIDATION_ERROR`	Das JSON-Objekt enthält ein nicht unterstütztes Feld, einen ungültigen Wert oder ein fehlendes erforderliches Argument.
401	`API_KEY_EXPIRED`	Der API-Schlüssel ist abgelaufen.
401	`INVALID_API_KEY`	Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an.
401	`INVALID_CREDENTIAL`	Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key.
401	`MISSING_CREDENTIAL`	Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen.
401	`USER_NOT_FOUND`	Das Konto des Zugangsnachweises existiert nicht mehr.
403	`ACCOUNT_UNAVAILABLE`	Das ausführende Konto oder das Abrechnungskonto ist nicht verfügbar oder wird gerade gelöscht.
403	`AMBIGUOUS_TEAM_API_KEY`	Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist.
403	`INSUFFICIENT_SCOPE`	Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten.
403	`INTEGRATION_PLAN_UNSUPPORTED`	Die Integrationslimits des Kontos konnten nicht verifiziert werden.
403	`PAID_SUBSCRIPTION_REQUIRED`	Das Speichern neuer oder geänderter Stimmvoreinstellungen für die Sprachausgabe erfordert ein wirksames kostenpflichtiges Abonnement.
403	`SUBSCRIPTION_REQUIRED`	Verwenden Sie ein aktives kostenpflichtiges Abonnement.
403	`TEAM_OWNER_NOT_FOUND`	Das maßgebliche Konto des Teaminhabers wurde nicht gefunden.
403	`TEAM_OWNER_REQUIRED`	Diese Aktion erfordert das Konto, dem das Team oder die gemeinsamen Einstellungen gehören.
404	`ACCOUNT_NOT_FOUND`	Das Konto oder das Konto des aktiven Arbeitsbereichs wurde nicht gefunden.
409	`CONCURRENT_ACTION_LIMIT_REACHED`	Für dieses Konto laufen bereits 10 Integrationsaktionen. Fragen Sie eine vorhandene Anfrage ab, bevor Sie eine weitere starten.
409	`IDEMPOTENCY_CONFLICT`	Verwenden Sie eine Kennung nur mit derselben Operation und denselben Argumenten erneut.
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif.
429	`INTEGRATION_RATE_LIMIT_REACHED`	Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle.
500	`INTERNAL_ERROR`	Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen.
503	`ACTION_RESULT_UNAVAILABLE`	Die Aktion wurde ausgeführt, ihr Ergebnis konnte jedoch nicht gespeichert werden. Prüfen Sie den gespeicherten Anfragestatus und den Ressourcenverlauf, bevor Sie eine neue Generierung starten.
503	`SERVER_RESTARTING`	Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei.

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

Überblick

Discovery

Konto

Nutzung und Aktivität

Einstellungen und Benachrichtigungen

Team

Projekte

Übersetzung und Synchronisation

Transkripte und Bearbeitung

Sprachausgabe

Stimmen für die Sprachausgabe

Synchronstimmen

Transkription

Untertitel

Bilder

Thumbnails

Ordner

Glossar

Webhooks

Veröffentlichung

Anfragestatus

OAuth- und MCP-Protokoll

Authentifizierung und Berechtigungen

Parameter

Idempotenz

Anfragebeispiele

Antwort

Ergebnisfelder

Diese Anfrage wiederherstellen und abfragen

Hinweise zur Operation

Nutzung

Fehler

​Authentifizierung und Berechtigungen

​Parameter

​Idempotenz

​Anfragebeispiele

​Antwort

​Ergebnisfelder

​Diese Anfrage wiederherstellen und abfragen

​Hinweise zur Operation

​Nutzung

​Fehler

Authentifizierung und Berechtigungen

Parameter

Idempotenz

Anfragebeispiele

Antwort

Ergebnisfelder

Diese Anfrage wiederherstellen und abfragen

Hinweise zur Operation

Nutzung

Fehler