{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"18b8b3f8-9124-4449-b227-d0193f52f82f","name":"Voicemod API","description":"# API Reference\n\nThe Voicemod API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Our API has predictable resource-oriented URLs, returns **JSON-encoded** responses, and uses standard **HTTP response codes**, **authentication**, and **verbs**.\n\nVoicemod API also provides access to user related data as user's catalog and twitch integration.\n\nThe API provides a set of endpoints, each with its own unique path. The application must get the user’s permission to access the data. Authorization is via the Accounts service.\n\n# Requests\n\nThe API is based on REST principles. Data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Where possible, API uses appropriate HTTP verbs for each action:\n\n| METHOD | ACTION |\n| --- | --- |\n| **GET** | Retrieves resources. |\n| **POST** | Create resources. |\n| **UPDATE** | Changes and/or replaces resources or collections. |\n| **PATCH** | Making partial changes to an existing resource. |\n| **DELETE** | Create resources. |\n\n# Responses Status Code\n\nAPI uses the following response status codes, as defined in the RFC 2616 and RFC 6585.\n\nAll API requests must be made over **HTTPS**. Calls made over plain HTTP will fail.\n\n| HTTP STATUS CODE | SUMMARY |\n| --- | --- |\n| **200 - OK** | Everything worked as expected. |\n| **202 - Accepted** | The request has been accepted for processing, but the processing has not been completed. |\n| **204 - No Content** | Everything worked as expected and no content included in response body. |\n| **400 - Bad Request** | The request was unacceptable, often due to missing a required parameter. |\n| **401 - Unauthorized** | No valid Access Token provided. |\n| **403 - Forbidden** | The Access Token doesn't have permissions to perform the request. |\n| **404 - Not Found** | The requested resource doesn't exist. |\n| **500 - Server Errors** | Something went wrong on Voicemod's end. |\n\n---\n\n# Errors\n\nVoicemod API uses conventional HTTP response codes to indicate the success or failure of an API request. In general codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the `5xx` range indicate an error with Voicemod's servers (they are not common).\n\nSome `4xx` errors that could be handled programmatically (e.g.,invalid parameters) beside it includes an JSON object error with a message and description that briefly explains the reported error.\n\n| Name | Description | Type |\n| --- | --- | --- |\n| **message** | A human-readable message indicating which is the problem | `string` |\n| **description** | More accurate description of the error | `string` |\n| **code** | Code for identifying the error | `String` |\n\n---\n\n# Signing And Verification\n\nAn optional request identifier can be added to each API request. You can provide this value under a custom request header called `request-id`. If you provide the request identifier you will receive a signature in the HTTP response that will let you verify that it hasn't been tampered, so you can ensure that Voicemod API originally sent it.  \nThis identifier should be unique by request, you should consider something like a timestamp or similar.\n\n_Voicemod API signing process_:\n\n<img src=\"https://drive.google.com/uc?export=view&amp;id=1W59cFFEddeoBYcgdpr58-TEK8HOG7QbO\" alt=\"RSA\">\n\n_Response Signature Headers_:\n\n| Header | Description |\n| --- | --- |\n| **request-id** | The same value you provided for this header in the request. |\n| **digest** | Contains the algorithm used to generate the signature plus the signature of the body payload.  <br>  <br>Example:  <br>`SHA-256=JHi7hApoV19g6rjNCJDKVX8RLXaLMDk75rpZlBoS/t5nEyfLXVIKRAw8l/Oy1MWDQ==` |\n| **signature-headers** | Contains the name of the headers, separated by spaces, whose content was used to generate the signature.  <br>  <br>Example:  <br>`request-id digest` |\n| **signature** | Contains the signature value.  <br>  <br>Example:  <br>`MxqFhS7cGc9gBzpjpW7Ng9i5oTL8HLQssJ02zZkvQtjl13flyyKvwygQV7ilI7VG1K89+3iJPxR3k1feUDU8bw==` |\n\n_Client verification process_:\n\n<img src=\"https://drive.google.com/uc?export=view&amp;id=1VBqJ-3G3wKAzo2JTdbBAlpvmouN9f3Sb\" alt=\"RSA\">\n\nAnyone who has the signature, the message, and the public key, can use RSA verification to make sure that the message actually came from the party by whom the public key is issued. If the data or signature doesn’t match, the verification process fails.\n\nAsk us about your public key.\n\nIf you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n---\n\n# Versioning\n\nWhen backwards-incompatible changes are made to the API, a new version is released. The current version is `v1`.  \nThe version is specified in all requests Urls.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13339926","collectionId":"18b8b3f8-9124-4449-b227-d0193f52f82f","publishedId":"TVewak3G","public":true,"publicUrl":"https://doc.voicemod.tech","privateUrl":"https://go.postman.co/documentation/13339926-18b8b3f8-9124-4449-b227-d0193f52f82f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-02-15T12:53:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Staging","id":"8de56e19-613d-4646-a41f-90f2403aaa49","owner":"13339926","values":[{"key":"twitchUrl","value":"https://api.voicemod.net/v1/twitch","enabled":true,"type":"default"},{"key":"voicemodRefreshToken","value":"","enabled":true,"type":"default"},{"key":"voicemodToken","value":"","enabled":true,"type":"default"},{"key":"accountsUrl","value":"https://staging-gateway-api.voicemod.net/v1/accounts","enabled":true,"type":"default"},{"key":"oauthUrl","value":"https://staging-gateway-api.voicemod.net/v1/oauth","enabled":true,"type":"default"},{"key":"authUrl","value":"https://staging-gateway-api.voicemod.net/v1/auth","enabled":true,"type":"default"},{"key":"catalogUrl","value":"https://staging-gateway-api.voicemod.net/v1/catalog","enabled":true,"type":"default"},{"key":"irisUrl","value":"https://staging-gateway-api.voicemod.net/v1/iris","enabled":true,"type":"default"},{"key":"ordersUrl","value":"https://staging-gateway-api.voicemod.net/v1/orders","enabled":true,"type":"default"},{"key":"accountsEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/accounts","enabled":true,"type":"default"},{"key":"ordersEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/orders","enabled":true,"type":"default"},{"key":"irisEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/iris","enabled":true,"type":"default"},{"key":"notificationsUrl","value":"https://staging-gateway-api.voicemod.net/v1/notifications","enabled":true,"type":"default"},{"key":"desktopUrl","value":"https://staging-gateway-api.voicemod.net/v1/desktop","enabled":true,"type":"default"},{"key":"configUrl","value":"https://staging-gateway-api.voicemod.net/v1/configs","enabled":true,"type":"default"},{"key":"contentDeliveryUrl","value":"https://staging-gateway-api.voicemod.net/v1/content","enabled":true,"type":"default"},{"key":"tunaSoundsUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"tunaSoundsWorkerUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"tunaStatsUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"tunaUsersUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"tunaCollectionsUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"tunaSeoUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"VMCloudUrl","value":"https://staging-gateway-api.voicemod.net/v1/cloud","enabled":true,"type":"default"},{"key":"legacyAccountsUrl","value":"https://staging-gateway-api.voicemod.net/v1/legacy/accounts","enabled":true,"type":"default"},{"key":"nextGenUrl","value":"https://staging-gateway-api.voicemod.net/v1/nextgen","enabled":true,"type":"default"},{"key":"VMCloudv2Url","value":"https://staging-gateway-api.voicemod.net/v2/cloud","enabled":true,"type":"default"},{"key":"inventoryUrl","value":"https://staging-gateway-api.voicemod.net/v1/inventory","enabled":true,"type":"default"},{"key":"catalogEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/catalog","enabled":true,"type":"default"},{"key":"contentDeliveryEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/content","enabled":true,"type":"default"},{"key":"accessControlUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/content-access","enabled":true,"type":"default"},{"key":"nextGenContentDeliveryUrl","value":"https://staging-gateway-api.voicemod.net/v1/nextgen/content","enabled":true,"type":"default"},{"key":"contentDeliveryV2Url","value":"https://staging-gateway-api.voicemod.net/engineering/v2/content","enabled":true,"type":"default"},{"key":"nextGenContentDeliveryV2Url","value":"https://staging-gateway-api.voicemod.net/v2/nextgen/content","enabled":true,"type":"default"},{"key":"voicemodUserId","value":"","enabled":true,"type":"any"},{"key":"VMCloudv2EngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v2/cloud","enabled":true,"type":"default"},{"key":"inventoryEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/inventory","enabled":true,"type":"default"},{"key":"accountsV2engineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v2/accounts","enabled":true,"type":"default"},{"key":"notificationsV1engineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/notifications","enabled":true,"type":"default"},{"key":"deeplinkUrl","value":"https://staging-gateway-api.voicemod.net/v1/deeplink","enabled":true,"type":"default"},{"key":"contentHubV2Url","value":"https://staging-gateway-api.voicemod.net/v2/content","enabled":true,"type":"default"},{"key":"mobileHubUrl","value":"https://staging-gateway-api.voicemod.net/v1/content/mobile","enabled":true,"type":"default"},{"key":"voicecallsUrl","value":"https://staging-gateway-api.voicemod.net/v1/voicecalls","enabled":true,"type":"default"},{"key":"voiceDesignerUrl","value":"https://staging-gateway-api.voicemod.net/v1/voice-designer","enabled":true,"type":"default"},{"key":"contentHubUrl","value":"https://staging-gateway-api.voicemod.net/v1/content","enabled":true,"type":"default"},{"key":"contentHubMonolithUrl","value":"https://staging-gateway-api.voicemod.net/v1/content-hub","enabled":true,"type":"default"},{"key":"tunaCompositionUrl","value":"https://staging-tuna-gateway-api.voicemod.net/v1","enabled":true,"type":"default"},{"key":"customerEventsUrl","value":"https://staging-gateway-api.voicemod.net/v1/customer-events","enabled":true,"type":"default"},{"key":"customerEventsEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/customer-events","enabled":true,"type":"default"},{"key":"ordersUrlV2","value":"https://staging-gateway-api.voicemod.net/v2/orders","enabled":true,"type":"default"},{"key":"contentHubMonolithEngineeringUrl","value":"https://staging-gateway-api.voicemod.net/engineering/v1/content-hub","enabled":true,"type":"default"},{"key":"tunaEngineering","value":"https://staging-tuna-gateway-api.voicemod.net/engineering","enabled":true,"type":"default"},{"key":"revenuecat_auth","value":"","enabled":true,"type":"secret"},{"key":"baseTunaGateway","value":"https://staging-tuna-gateway-api.voicemod.net","enabled":true,"type":"default"},{"key":"contentHubMonolithUrlV3","value":"https://staging-gateway-api.voicemod.net/v3/content-hub","enabled":true,"type":"default"},{"key":"nextGenContentDeliveryV3Url","value":"","enabled":true,"type":"any"},{"key":"_oauth2_proxy","value":"","enabled":true,"type":"any"},{"key":"trialCode","value":"","enabled":true,"type":"default"},{"key":"trialCodeRaw","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://voicemod.tech/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Staging","value":"13339926-8de56e19-613d-4646-a41f-90f2403aaa49"}],"canonicalUrl":"https://doc.voicemod.tech/view/metadata/TVewak3G"}