{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","description":"📦 **Caleida API Collection Documentation**\n\nWelcome to the Caleida API Collection documentation. This guide provides everything you need to integrate and utilize our API to optimize your customer acquisition, engagement, and conversion processes.\n\n### Obtaining Your API Key 🗝️\n\nTo access the Caleida API securely and integrate its powerful features into your applications, follow these steps:\n\n- **Login To Caleida Account**: Sign in to your Caleida account by visiting the [Caleida Login Page](https://caleida.com/login).\n    \n- **Select Project**: Choose the project within your Caleida account for which you want to generate the API key.\n    \n- **Navigate To Integrations**: Click on **INTEGRATIONS** in the sidebar menu to manage integrations and API settings.\n    \n- **Access Advanced Settings**: Navigate to the **ADVANCED** section and locate the settings for API keys.\n    \n- **Generate API Key**: Click on the settings button of the API key card, then select **Add API key**. Fill out any required form or details as prompted.\n    \n- **Copy API Key**: Once the API key is generated, copy the API key value provided. This API key is crucial for authenticating your API requests.\n    \n\n### Using Your API Key\n\nUse the API key in the header of every API request you make to Caleida:\n\n- **Header Key**: `X-API-KEY`\n    \n- **Header Value**: Paste the API key obtained from the Caleida dashboard.\n    \n\n---\n\n**Secure Integration Practices** 🛡️\n\n- Ensure all API requests are made over HTTPS to encrypt data transmission.\n    \n- Safeguard your API key from unauthorized access or exposure by storing it securely.\n    \n- Consider using environment variables or secure vaults to manage your API key in production environments.\n    \n\n---\n\n**Rate Throttle Limits** ⏳\n\nEach API endpoint has specific rate throttle limits, governing the maximum allowable requests per unit of time. Exceeding these limits may result in temporary blocks or throttling of requests.\n\n- **Auth:** Essential for authentication, allowing 10 requests per minute to handle user authentication and authorization processes, ensuring secure access to APIs and resources.\n    \n- **Configs:** Enables configuration tasks across platforms like Telegram, WhatsApp, Slack, and web integrations, supporting 60 requests per second for managing agent templates and projects.\n    \n- **Chats:** Supports 300 requests per minute for managing chat-related operations.\n    \n- **Messages:** Allows 300 requests per minute for managing message-related operations.\n    \n- **Insights:** Permits 300 requests per minute for accessing analytical insights.\n    \n- **Base:** Used for billing operations and alerts, with a limit of 50 requests per second.\n    \n- **Files:** Supports file operations with a limit of 50 requests per minute, and 100 file operations per hour.\n    \n- **Webhooks:** Supports integration with webhooks at a rate of 60 requests per minute.\n    \n- **Request API:** Handles miscellaneous requests with a limit of 10 requests per hour.\n    \n\nUnderstanding these distinctions ensures efficient utilization of each API for its specific tasks while maintaining compliance with rate limits to optimize performance.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"35967625","team":6265730,"collectionId":"e34b726a-9403-485c-b370-5609b51a10b5","publishedId":"2sA3Qy6UbA","public":true,"publicUrl":"https://api.caleida.io","privateUrl":"https://go.postman.co/documentation/35967625-e34b726a-9403-485c-b370-5609b51a10b5","customColor":{"top-bar":"412C53","right-sidebar":"303030","highlight":"74419D"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/84f2435f-8a66-4c50-a81f-ce9d7b5c40de/Y2FsZWlkYS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"E4D9EB"}},{"name":"light","logo":"https://content.pstmn.io/84f2435f-8a66-4c50-a81f-ce9d7b5c40de/Y2FsZWlkYS5wbmc=","colors":{"top-bar":"412C53","right-sidebar":"303030","highlight":"74419D"}}]}},"version":"8.11.6","publishDate":"2024-06-28T05:44:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/84f2435f-8a66-4c50-a81f-ce9d7b5c40de/Y2FsZWlkYS5wbmc=","logoDark":"https://content.pstmn.io/84f2435f-8a66-4c50-a81f-ce9d7b5c40de/Y2FsZWlkYS5wbmc="}},"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/83515f03e2128fb7fd72a25fc13b441ba21b7d09fa36c926d5e4c8b6e0cbc9ca","favicon":"https://res.cloudinary.com/postman/image/upload/v1719552608/team/xgic3tafgxfrtdpnpule.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://api.caleida.io/view/metadata/2sA3Qy6UbA"}