{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b8170f0a-37f1-46e3-a852-d500f7c5691d","name":"AiTrillion REST APIs","description":"## Introduction\n\nWelcome to the AiTrillion REST API documentation. This guide is designed to provide you with comprehensive information about integrating and interacting with AiTrillion's RESTful APIs.\n\nAiTrillion offers two types of APIs:\n\n- **Server Side APIs:** AiTrillion server-side REST API provides a way to move your data into AiTrillion and get your data from AiTrillion.\n    \n- **Front Store APIs:** The AiTrillion Front Store API offers a way to seamlessly bring AiTrillion's front store widget data directly into your own store. Unlike server-side API calls, this lets you use Ajax calls to directly access AiTrillion Front Store APIs from your store's front end.\n    \n\nEach type of API has its own unique authentication and rate limits. More details about these APIs can be found later in this document.\n\n## API Reference\n\nThe AiTrillion REST API provides a set of endpoints that allow you to perform various actions and access essential data. Each API endpoint is designed to serve a specific purpose and follows RESTful principles, utilizing HTTP methods like GET, POST, PUT, and DELETE. In this section, you'll find detailed information about each API endpoint, its parameters, request and response formats, authentication requirements, and usage examples.\n\n## Getting started\n\nTo get started with the AiTrillion REST API, follow these steps:\n\n1. **Obtain an API Key:** Log in to your AiTrillion account and generate an API key from the [API access page](https://app.aitrillion.com/manage/apiaccess) under My Account.\n    \n2. **Review the Documentation:** Familiarize yourself with the API endpoints, authentication requirements, request and response formats, and usage examples provided in this documentation.\n    \n3. **Make API Requests:** Use your preferred programming language and HTTP library to craft API requests according to the documentation.\n    \n4. **Handle Responses:** Implement proper error handling and response parsing in your application to ensure smooth integration with the AiTrillion platform.\n    \n5. **Test Thoroughly:** Before deploying your application, test the API integration thoroughly in a controlled environment to identify and address any potential issues.\n    \n\nNow, let's dive into the specific API endpoints and their functionalities. Choose the endpoint that best suits your needs\n\n## Error Handling\n\nWhen interacting with the AiTrillion API, you may encounter errors due to various reasons such as invalid parameters, authentication issues, API rate limit, or server problems. Error responses follow standard HTTP status codes, along with a JSON response body & header containing details about the error. It's important to handle these errors gracefully in your application to ensure a smooth user experience.\n\n## Rate Limiting\n\nRate Limiting for AiTrillion is implemented on a per-API key/token per second.\n\n#### Introduction\n\nThis documentation outlines the rate limiting policy for our API. Rate limiting is implemented to ensure fair usage of our API resources and to maintain the quality of service for all users.\n\n#### Rate Limit Policy\n\nThe rate limit for our API is set at **2 calls per second** per API key/token by default. This means that each unique API key/token is allowed to make up to 2 API requests per second. More usage contact sales team.\n\n#### How Rate Limiting Works\n\nRate limiting is implemented on a per-API key/token basis. When a request is made to our API, we track the rate of requests made by each API key/token. If the rate of requests exceeds the allowed limit (2 calls per second), further requests will be temporarily blocked and will receive a response with an HTTP status code of `429 Too Many Requests`.\n\n#### Response Headers\n\nWhen making requests to our API, you will receive the following response headers related to rate limiting:\n\n- `X-AIO-Api-Call-Limit`: The total number of requests consume / total allowed per second for the API key/token.\n    \n\nHere's an example of how these headers might look in a response:  \n`HTTP/1.1 200 OK`\n\n`X-AIO-Api-Call-Limit: 1/2`\n\ni.e. 1 request is used out of 2 requests per second quota.\n\n## Help and support\n\nIf you're facing issues that aren't covered in the documentation or FAQs, our dedicated support team is here to help. You can reach out to us through our official support channels:\n\n- **Email:** Drop us an email at [support@aitrillion.com](https://mailto:support@aitrillion.com), and our support team will get back to you as soon as possible.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"28948341","team":5445177,"collectionId":"b8170f0a-37f1-46e3-a852-d500f7c5691d","publishedId":"2s9Xy2PCS2","public":true,"publicUrl":"https://developer.aitrillion.com","privateUrl":"https://go.postman.co/documentation/28948341-b8170f0a-37f1-46e3-a852-d500f7c5691d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1A73E8"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/25b9ac75-46af-49ec-8920-e7777cd398f8/ZnVsbC1sb2dvLWRhcmsucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"73AFFF"}},{"name":"light","logo":"https://content.pstmn.io/2d1eb593-309a-4975-98db-987e15685bc5/ZnVsbC1sb2dvLWxpZ2h0LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1A73E8"}}]}},"version":"8.10.1","publishDate":"2023-08-29T08:23:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/2d1eb593-309a-4975-98db-987e15685bc5/ZnVsbC1sb2dvLWxpZ2h0LnBuZw==","logoDark":"https://content.pstmn.io/25b9ac75-46af-49ec-8920-e7777cd398f8/ZnVsbC1sb2dvLWRhcmsucG5n"}},"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/c5c52ba74f52ab33ab87eb5a93f58d62c29fe7e69f77cfd2b14b3a5bb3b488c7","favicon":"https://aitrillion.com/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"}],"canonicalUrl":"https://developer.aitrillion.com/view/metadata/2s9Xy2PCS2"}