Accountinstellingen bijwerken

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"
}

Werk ondersteunde persoonlijke instellingen bij. Alleen de teameigenaar kan gedeelde woordenschat en vertaalinstructies wijzigen. Niet-opgegeven instellingen blijven ongewijzigd.

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

Authenticatie en machtigingen

string

vereist

Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.

Vereiste machtigingen: settings:write. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

Parameters

string

Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon: ^[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

Tekstwaarde.Minimale lengte: 1. Maximale lengte: 120.

array

Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Maximaal aantal items: 1000.

string

Tekstwaarde.Maximale lengte: 500.

union

Accepteert de alternatieven uit het volledige invoerschema.

array

Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Maximaal aantal items: 50.

array

Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Maximaal aantal items: 10.

object

JSON-object. Zie het volledige invoerschema voor de geneste velden.

boolean

Booleaanse waarde.

boolean

Booleaanse waarde.

Volledig invoerschema

Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

{
  "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
}

Idempotentie

Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.

Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

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)

Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Bevestigt dat de opgegeven ondersteunde instellingen zijn opgeslagen.

{
  "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"
}

Resultaatvelden

Veld	Beschrijving
`data.updated`	true nadat de instellingen zijn bijgewerkt.

Deze aanvraag herstellen en controleren

Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.

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
    }
  }
}

Opmerkingen bij de bewerking

Geef naast de optionele requestId ten minste één instelling op. Weggelaten instellingen blijven ongewijzigd.
Alleen de teameigenaar kan brandVocabulary en customTranslationInstructions wijzigen. Teamleden kunnen hun eigen overige voorkeuren bijwerken.
De woordenschat accepteert maximaal 1,000 termen. Elke genormaliseerde term mag maximaal 49 tekens en vijf woorden bevatten, zonder vierkante haken, accolades, punthaken of backslashes. Dubbele termen worden verwijderd, ongeacht hoofdlettergebruik.
Bedrijfsnamen bevatten 1–120 tekens. Vertaalinstructies voor het account bevatten maximaal 500 tekens.
Taal- en kanaalvoorinstellingen accepteren maximaal 50 voorinstellingen, elk met 1–50 geselecteerde talen of kanalen. Merkvoorinstellingen voor tekst-naar-spraak accepteren maximaal 10 unieke IDs, namen van 60 tekens, instructies van 300 tekens en speed van 0.5 tot 2.

Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

Fouten

HTTP-status	Code	Betekenis of herstel
400	`CREDENTIAL_IN_QUERY`	Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers.
400	`IDEMPOTENCY_CONFLICT`	De header Idempotency-Key en het bodyveld requestId moeten overeenkomen.
400	`INVALID_BRAND_VOCABULARY`	Een of meer woordenschattermen voldoen niet aan de regels voor termlengte, woordenaantal of tekens.
400	`INVALID_REQUEST_ID`	Geef een UUID v4 op als requestId of Idempotency-Key.
400	`VALIDATION_ERROR`	Het JSON-object bevat een niet-ondersteund veld, een ongeldige waarde of een ontbrekend verplicht argument.
401	`API_KEY_EXPIRED`	De API-sleutel is verlopen.
401	`INVALID_API_KEY`	Geef een geldige, niet-verlopen API-sleutel op.
401	`INVALID_CREDENTIAL`	De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key.
401	`MISSING_CREDENTIAL`	Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens.
401	`USER_NOT_FOUND`	Het account dat bij de toegangsgegevens hoort, bestaat niet meer.
403	`ACCOUNT_UNAVAILABLE`	Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd.
403	`AMBIGUOUS_TEAM_API_KEY`	De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is.
403	`INSUFFICIENT_SCOPE`	Verleen alle vereiste machtigingen of kies andere toegangsgegevens.
403	`INTEGRATION_PLAN_UNSUPPORTED`	De integratielimieten van het account konden niet worden geverifieerd.
403	`PAID_SUBSCRIPTION_REQUIRED`	Voor het opslaan van nieuwe of gewijzigde stemvoorinstellingen voor tekst-naar-spraak is een effectief betaald abonnement vereist.
403	`SUBSCRIPTION_REQUIRED`	Gebruik een actief betaald abonnement.
403	`TEAM_OWNER_NOT_FOUND`	Het effectieve account van de teameigenaar kon niet worden gevonden.
403	`TEAM_OWNER_REQUIRED`	Deze actie vereist het account dat eigenaar is van het team of de gedeelde instellingen.
404	`ACCOUNT_NOT_FOUND`	Het account of het account van de actieve werkruimte kon niet worden gevonden.
409	`CONCURRENT_ACTION_LIMIT_REACHED`	Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start.
409	`IDEMPOTENCY_CONFLICT`	Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten.
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	Wacht tot de maandelijkse reset of wijzig je abonnement.
429	`INTEGRATION_RATE_LIMIT_REACHED`	Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen.
500	`INTERNAL_ERROR`	Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen.
503	`ACTION_RESULT_UNAVAILABLE`	De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start.
503	`SERVER_RESTARTING`	De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie.

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

Overzicht

Discovery

Account

Verbruik en activiteit

Instellingen en meldingen

Team

Projecten

Vertaling en nasynchronisatie

Transcripten en bewerking

Tekst naar spraak

Spraakstemmen

Nasynchronisatiestemmen

Transcriptie

Ondertitels en captions

Afbeeldingen

Miniaturen

Mappen

Woordenlijst

Webhooks

Publiceren

Aanvraagstatus

OAuth en het MCP-protocol

Authenticatie en machtigingen

Parameters

Idempotentie

Voorbeeldaanvragen

Antwoord

Resultaatvelden

Deze aanvraag herstellen en controleren

Opmerkingen bij de bewerking

Verbruik

Fouten

​Authenticatie en machtigingen

​Parameters

​Idempotentie

​Voorbeeldaanvragen

​Antwoord

​Resultaatvelden

​Deze aanvraag herstellen en controleren

​Opmerkingen bij de bewerking

​Verbruik

​Fouten

Authenticatie en machtigingen

Parameters

Idempotentie

Voorbeeldaanvragen

Antwoord

Resultaatvelden

Deze aanvraag herstellen en controleren

Opmerkingen bij de bewerking

Verbruik

Fouten