{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8f2cdeea-9c46-420d-be13-a13f886c24ce","name":"BitFractal API","description":"Please read carefully this entire section before using the BitFractal API.\n\n## **Getting started guide**\n\nTo start using the BitFractal API, you need to:\n\n- You must use a valid API Key and Customer ID to send requests to the API endpoints.\n    \n- The API has rate and usage limits.\n    \n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.\n    \n- The API supports GET and POST requests. We recommend using POST requests for all functions.\n    \n- The API returns request responses in plain text, JSON format, or application/octet-stream (for audio files), when applicable. When an API request returns an error, it is sent in the form of a HTTP error code and a response text.\n    \n\n## Authentication\n\nThe BitFractal API uses an API Key for authentication.\n\nYou must include an API key in each request to the BitFracal API with the `code` request header.\n\nIt's also required to provide your unique customer id, using the `custid` parameter on every request.\n\nBoth pieces of information were made available to your organization upon subscribing. If you have any difficulties finding this information or need any assistance, please reach out to [support@bitfractal.com](https://mailto:support@bitfractal.com).\n\nAlthough the same pair of customer id and API key can be used across all APIs, each API can have different subscription plans. Make sure you have properly subscribed to the APIs you need prior to using them.\n\n### Authentication error response\n\nIf an API key or customer id are missing, malformed, or invalid, you will receive an HTTP `401` Unauthorized response code or an error `400`.\n\n## Regions and Endpoints\n\nThe BitFractal API is currently available in 3 regions: East US, UK South, and Brazil South, and that can be accessed as below:\n\n**US East:** `https://api.eastus.bitfractal.com/api/`\n\n**UK South:** `https://api.uksouth.bitfractal.com/api/`\n\n**Brazil South:** `https://api.brazilsouth.bitfractal.com/api/`\n\nOther regions can be added upon request. Please reach out to [support@bitfractal.com](https://mailto:support@bitfractal.com) for that.\n\nThe BitFractal AutoQM Analytics API for enterprise customers is accessible via a dedicated url and SaaS infrastructure. The url format will be as follow: `https://{{yourcompanyalias}}.autoqmanalytics.bitfractal.com/api/`\n\n## Rate and usage limits\n\nAPI access rate limits apply at a per-API key basis in unit time. The limit is 600 requests per minute and 100 concurrent requests, with a maximum request execution time of 230 seconds. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.\n\nIt's recommended to implement a retry policy on the client side.\n\n### Cold Start Behavior\n\nThe BitFractal API operates with auto-scale, allocating more or less resources as needed. These type of apps may scale to zero when idle, meaning some requests may have additional latency at startup. Our solution does have some optimizations to help decrease cold start time, including pulling from pre-warmed placeholder functions that already have the function host and language processes running.\n\n### 400 response\n\nAn HTTP `400` response from our servers indicates there is an unexpected error processing your request. Usually these errors indicate malformed parameters sent to the API. If the error persists, make note of date, time, and error message and contact [support@bitfractal.com](https://mailto:support@bitfractal.com).\n\n### 503 response\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, contact [support@bitfractal.com](https://mailto:support@bitfractal.com).\n\nThe BitFractal API is currently available in 2 regions: Brazil South, and East US. The calling application must be able to handle these errors and can choose to switch to a secondary region to retry the request. Other forms of error handling can include throttleling and wait and retry. If necessary, contact [support@bitfractal.com](https://mailto:support@bitfractal.com).\n\n### Supported Languages\n\nBitFractal has an extensive list of supported languages and this list is frequently update as we expand our global languages support. Please refer to [this page](https://www.bitfractal.com/post/bitfractal-tts-languages) for an updated list.\n\n### Available Voices\n\nBitFractal has an extensive list of supported voices and this list is frequently update as we expand our global languages support. Please refer to [this page](https://www.bitfractal.com/post/bitfractal-tts-languages) for an updated list.\n\n### Supported Input Audio Formats\n\nThe input audio sent to the service for transcription can be of any of the following formats: `wav, opus, ogg, webm, or mp3`. Setting the `autodect` parameter to `1` will allow the service to automatically identify the audio bitrate, channels, and sample rate. Otherwise that must be provided on the API call.\n\n### Supported Output Audio Formats\n\nThe `output` parameter of the TTS API, defines the audio output format and frequency. The default format is 16Khz MP3 (`\"output\": \"16-mp3\"`). These other formats are also supported:\n\n| **Output Format** | **Output Code** |\n| --- | --- |\n| 16Khz - MP3 | 16-mp3 |\n| 24Khz - MP3 | 24-mp3 |\n| 48Khz - MP3 | 48-mp3 |\n| 8Khz - WAV | 8-wav |\n| 16Khz - WAV | 16-wav |\n| 24Khz - WAV | 24-wav |\n| 48Khz - WAV | 48-wav |\n| 16Khz - OGG | 16-ogg |\n| 24Khz - OGG | 24-ogg |\n| 48Khz - OGG | 48-ogg |\n\n**Note:** Different formats will yeld different audio quality and audio file size, impacting in processing time for the audio generation. Make sure you balance quality versus performance while building your application.\n\n### Downloading Returned Audio File\n\nThe audio file generated by the BitFractal TTS API will be returned to the caller either in a application/octet-stream web response using the audio file format defined in the web request. If necessary by your application, the data stream should be serialized to a local file, or as a direct link to access the audio file from a temporary blob location. The file will persist in the temporary blob location for 15 mins. The parameter `returnaudio` will set the response type, being the default 0, to return a link to the file or 1 to return the audio data in the reponse body.\n\n### Advanced Mode with SSML\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, contact [support@bitfractal.com](https://mailto:support@bitfractal.com).\n\n### Open AI models used by the Conversational AI API\n\nCurrently, the Conversational AI API is set to work with the GPT4o-mini model. GPT-4 or other models can be used upon request and can represent a different cost. If necessary, please contact [support@bitfractal.com](https://mailto:support@bitfractal.com).\n\nDue to currentl availabilty these models are currently deployed as below:\n\n**US East:** Deployed to the US datacenter.\n\n**UK South:** Deployed to the UK datacenter.\n\n**Brazil South:** Deployed to the Brazil South datacenter.\n\n### **Need some help?**\n\nIn case you have questions, go through our tutorials and readiness resources available at our website: [https://www.bitfractal.com/](https://www.bitfractal.com/) or contact [support@bitfractal.com](https://mailto:support@bitfractal.com).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2466848","team":6071021,"collectionId":"8f2cdeea-9c46-420d-be13-a13f886c24ce","publishedId":"2sA2rGvKmZ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2466848/2sA2rGvKmZ","privateUrl":"https://go.postman.co/documentation/2466848-8f2cdeea-9c46-420d-be13-a13f886c24ce","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FD6262"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FD6262"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FD6262"}}]}},"version":"8.10.1","publishDate":"2024-03-02T18:43:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/24f7fdd449cbc1ecf51035af57cd46eb2eb18720e60477cbc0d1ea744b0be574","favicon":"https://res.cloudinary.com/postman/image/upload/v1709246306/team/g7tzbq6p7uex4xx7k4k6.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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA2rGvKmZ"}