{"info":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","description":"

📦 Caleida API Collection Documentation

Welcome 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.

Obtaining Your API Key 🗝️

To access the Caleida API securely and integrate its powerful features into your applications, follow these steps:

Login To Caleida Account: Sign in to your Caleida account by visiting the Caleida Login Page.
\n
Select Project: Choose the project within your Caleida account for which you want to generate the API key.
\n
Navigate To Integrations: Click on INTEGRATIONS in the sidebar menu to manage integrations and API settings.
\n
Access Advanced Settings: Navigate to the ADVANCED section and locate the settings for API keys.
\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
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

Using Your API Key

Use the API key in the header of every API request you make to Caleida:

Header Key: X-API-KEY
\n
Header Value: Paste the API key obtained from the Caleida dashboard.
\n

Secure Integration Practices 🛡️

Ensure all API requests are made over HTTPS to encrypt data transmission.
\n
Safeguard your API key from unauthorized access or exposure by storing it securely.
\n
Consider using environment variables or secure vaults to manage your API key in production environments.
\n

Rate Throttle Limits ⏳

Each 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.

Auth: Essential for authentication, allowing 10 requests per minute to handle user authentication and authorization processes, ensuring secure access to APIs and resources.
\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
Chats: Supports 300 requests per minute for managing chat-related operations.
\n
Messages: Allows 300 requests per minute for managing message-related operations.
\n
Insights: Permits 300 requests per minute for accessing analytical insights.
\n
Base: Used for billing operations and alerts, with a limit of 50 requests per second.
\n
Files: Supports file operations with a limit of 50 requests per minute, and 100 file operations per hour.
\n
Webhooks: Supports integration with webhooks at a rate of 60 requests per minute.
\n
Request API: Handles miscellaneous requests with a limit of 10 requests per hour.
\n

Understanding these distinctions ensures efficient utilization of each API for its specific tasks while maintaining compliance with rate limits to optimize performance.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35967625","collectionId":"e34b726a-9403-485c-b370-5609b51a10b5","publishedId":"2sA3Qy6UbA","public":true,"customColor":{"top-bar":"412C53","right-sidebar":"303030","highlight":"74419D"},"publishDate":"2024-06-28T05:44:32.000Z"},"item":[{"name":"Auth","item":[{"name":"User","item":[{"name":"Update","id":"cbf5ede7-3dcf-4258-b3e2-f867715f9ab8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Your name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/iam/","description":"

IAM Endpoint PATCH Request

This endpoint allows the user to update the IAM (Identity and Access Management) information.

Request Body

name (string, required): The updated name for the IAM.

Response

The response for this request is a JSON object conforming to the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    // Define the properties of the response object here\n  }\n}\n\n

Get IAM Details

This endpoint retrieves IAM (Identity and Access Management) details.

Request Body

This request does not require a request body.

Response

id: The unique identifier for the IAM details.
\n
username: The username associated with the IAM.
\n
role: The role assigned to the user.
\n
permissions: An array of permissions granted to the user.
\n

Example:

{\n    \"id\": \"123\",\n    \"username\": \"example_user\",\n    \"role\": \"admin\",\n    \"permissions\": [\"read\", \"write\"]\n}\n\n

User Management

This section includes essential APIs for managing user profiles within the Caleida platform:

Get User 🧑‍💻
\n
- Description: Retrieve user profile information, including preferences and settings.
  \n
- Usage: Allows applications to fetch detailed user data for personalized experiences and service customization.
  \n
\n
Update User ✏️
\n
- Description: Modify user profile details such as name, email, and notification preferences.
  \n
- Usage: Enables users to update their personal information and communication preferences directly through the application.
  \n
\n

These APIs facilitate efficient user management, supporting personalized interactions and ensuring users can manage their profiles effectively within the Caleida platform.

Throttle Limit : BASE

\n","_postman_id":"dca25096-5a65-47c8-b4fc-de9f486bb430","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"id":"b231dbe7-1265-4720-bb56-fcc89c23acde","description":"

🔐 Authentication and User Management APIs

This section provides APIs essential for managing users within the Caleida platform:

User Management

Get User: Retrieve user profile information including preferences and settings.
\n
Update User: Modify user profile details such as name, email, and notification preferences.
\n

These APIs enable seamless user management and robust access control mechanisms, ensuring secure and personalized user experiences across the Caleida platform.

\n","_postman_id":"b231dbe7-1265-4720-bb56-fcc89c23acde","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Chat","item":[{"name":"Messages","item":[{"name":"Get","id":"caf5588d-48dd-4467-921a-ff25c3d52e7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/chats/records/{{chat_id}}/messages/?offset=0&limit=5","description":"

This endpoint retrieves chat messages for a specific chat record, based on the provided chat ID. The request includes query parameters for offset and limit to paginate through the messages.

Response

The response for this request is a JSON object representing the chat messages. The schema for the response can be documented as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"messages\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          // Properties of each message object\n        }\n      }\n    },\n    \"total_messages\": {\n      \"type\": \"integer\"\n    }\n  }\n}\n\n

The messages property is an array containing individual message objects, and total_messages represents the total count of messages available for the specified chat record.

This endpoint retrieves a specific message record within a chat. It requires the chat ID and the message ID to be provided in the URL parameters.

Request Body

This endpoint does not require a request body.

Response Body

id: The unique identifier for the message.
\n
sender: The sender of the message.
\n
timestamp: The timestamp when the message was sent.
\n
content: The content of the message.
\n

This endpoint allows the user to delete a specific message within a chat record. The request should be sent to the specified URL with the HTTP method set to DELETE. The chat_id parameter in the URL path should be replaced with the unique identifier of the chat record, and the message_id parameter should be replaced with the unique identifier of the message to be deleted.

Request Body

This request does not require a request body.

Response

Upon a successful deletion, the server will respond with a 204 No Content status code, indicating that the message has been successfully deleted. If the message or chat record does not exist, the server will respond with a 404 Not Found status code.

Get Document Messages

This endpoint makes an HTTP POST request to retrieve document messages for a specific chat.

Request Body

tag (string, optional): A tag to filter the document messages.

Response

The response of this request is as follows:

{\n    \"documents\": {\n        \"type\": \"array\",\n        \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"document_id\": {\n                    \"type\": \"string\"\n                },\n                \"document_name\": {\n                    \"type\": \"string\"\n                },\n                \"document_url\": {\n                    \"type\": \"string\"\n                }\n            }\n        }\n    }\n}\n\n

This JSON schema represents the structure of the response for retrieving document messages. It includes an array of documents, where each document has an ID, name, and URL.

Message Management

This section provides APIs for managing messages within the Caleida platform:

Send Messages ✉️
\n
- Description: This API allows you to send various types of messages within chats.
\n
Message History 📜
\n
- Description: This API provides access to retrieve and manage the history of messages exchanged within chats.
\n
Delete Message 🗑️
\n
- Description: This API enables the deletion of specific messages from a chat.
\n
Download Document 📄
\n
- Description: This API allows for the downloading of documents shared within messages.
\n

For more details, visit the Caleida dashboard.

\n","_postman_id":"38c1d1b8-a985-4f79-926d-ac2b4b64227a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Get","id":"c4cda20c-791c-4e0c-9ade-a69ffdecc7cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"https://core.stage.services.caleida.io/chats/records/?suid__startswith=+918348489129","description":"

This endpoint makes an HTTP GET request to retrieve chat records from the specified URL. The request does not contain a request body, as it is a GET request. The response will include the chat records in the specified format.

\n","urlObject":{"protocol":"https","path":["chats","records",""],"host":["core","stage","services","caleida","io"],"query":[{"disabled":true,"key":"limit","value":"5"},{"disabled":true,"key":"offset","value":"5"},{"disabled":true,"key":"ordering","value":"created"},{"disabled":true,"key":"user_details__meta__uid","value":""},{"disabled":true,"key":"project_id","value":"00000000-0000-0000-0000-00000000003b"},{"key":"suid__startswith","value":"+918348489129"}],"variable":[]}},"response":[{"id":"b33e253c-27c5-4cab-9183-62645934fce3","name":"Get","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/chats/records/","protocol":"https","host":["core","api","caleida","io"],"path":["chats","records",""],"query":[{"key":"limit","value":"5","disabled":true},{"key":"offset","value":"5","disabled":true},{"key":"ordering","value":"created","disabled":true},{"key":"user_details__meta__uid","value":"","disabled":true},{"key":"project_id","value":"00000000-0000-0000-0000-00000000003b","disabled":true},{"key":"suid__startswith","value":"27a5515c9a80","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 05:54:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45305"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"12b24c614f5b4375a0327d478ad26d9b"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 421,\n \"next\": \"http://core.stage.services.caleida.io/chats/records/?limit=100&offset=100\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"***\",\n \"message_count\": 0,\n \"campaign_name\": \"SDFFSDF\",\n \"created\": \"2024-06-04T05:41:04.389720Z\",\n \"modified\": \"2024-06-04T05:41:04.389720Z\",\n \"user_details\": {\n \"name\": \"SDFDSFSDF\",\n \"email\": \"\",\n \"phone\": \"**\"\n },\n \"channel\": \"whatsapp\",\n \"suid\": \"***\",\n \"uid\": \"**\",\n \"rating\": null,\n \"assigned\": null,\n \"auto\": true,\n \"iq\": false,\n \"ended\": false,\n \"project\": \"**\",\n \"campaign\": \"**\"\n }\n \n ]\n}"}],"_postman_id":"c4cda20c-791c-4e0c-9ade-a69ffdecc7cf"},{"name":"Get Stats","id":"f18ab94d-e436-40af-966f-c3f56eccb5e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/chats/records/get_stats/?since=30&project={{project_id}}","description":"

Get Chat Records Stats

This endpoint retrieves statistics for chat records based on the specified time period and project.

Request

Method: GET
\n
URL: /chats/records/get_stats/
\n
Query Parameters:
\n
- since (integer, required): Number of days to retrieve statistics for.
  \n
- project (string, required): ID of the project for which statistics are to be retrieved.
  \n
\n

Response

The response for this request will be a JSON object conforming to the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"total_records\": {\n      \"type\": \"integer\",\n      \"description\": \"Total number of chat records.\"\n    },\n    \"average_response_time\": {\n      \"type\": \"number\",\n      \"description\": \"Average response time for chat records.\"\n    },\n    \"most_active_user\": {\n      \"type\": \"string\",\n      \"description\": \"Username of the most active user.\"\n    },\n    \"total_users\": {\n      \"type\": \"integer\",\n      \"description\": \"Total number of users involved in chat records.\"\n    }\n  }\n}\n\n

This endpoint makes an HTTP GET request to retrieve message statistics for chats records. The since query parameter is used to specify the time frame for which the statistics are requested, and the project query parameter is used to identify the project for which the statistics are being retrieved.

The response will include the message statistics for the specified time frame and project.

Request Body: N/A
Response Body:

total_messages: The total number of messages.
\n
average_length: The average length of the messages.
\n
most_active_user: The user who has sent the most messages.
\n
message_frequency: The frequency of messages sent.
\n

This endpoint retrieves the chat records for a specific chat identified by the provided chat ID.

Request

Method: GET
\n
URL: /chats/records/{{chat_id}}/
\n

Response

The response will include the chat records for the specified chat ID.

Delete Chat Record

This API endpoint is used to delete a specific chat record identified by the chat_id.

Request

Method: DELETE
\n
Endpoint: /chats/records/{{chat_id}}/
\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"message\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

\n","urlObject":{"protocol":"https","path":["chats","records","{{chat_id}}",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"","value":"2fac9a7fad83494aae536fa81f3032fc"}],"variable":[]}},"response":[{"id":"ecc8f8ba-1cbe-422b-b565-0df359ec5237","name":"Delete One","originalRequest":{"method":"DELETE","header":[],"url":"https://core.api.caleida.io/chats/records/{{chat_id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 05:55:42 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"d264be16618b479681750d9b64945f9e"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7838d914-2044-4ca5-802a-208cdf69ad8f"},{"name":"Get Chat ID","id":"a5be7345-8823-4702-80d8-bce1065d739d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"SERVICE-BEARER-TOKEN","value":"Service 123456"}],"body":{"mode":"raw","raw":"{\n \"suid\": \"***\"\n // \"chat_id\": 453\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/chats/get_chat_detail/?project_id={{project_id}}","description":"

This endpoint is used to retrieve chat details for a specific project. The HTTP POST request should be made to /chats/get_chat_detail/?project_id={{project_id}} with the required payload.

Request Body

suid (string, required): The unique identifier for the chat.
\n
chat_id (number, optional): The ID of the chat.
\n

Response

The response for this request should be documented as a JSON schema.

\n","urlObject":{"protocol":"https","path":["chats","get_chat_detail",""],"host":["core","api","caleida","io"],"query":[{"key":"project_id","value":"{{project_id}}"}],"variable":[]}},"response":[{"id":"c91a61b3-542a-4922-b691-e0e45c2d2903","name":"Get Chat ID","originalRequest":{"method":"POST","header":[{"key":"SERVICE-BEARER-TOKEN","value":"**","disabled":true}],"body":{"mode":"raw","raw":"{\n \"suid\": \"**\"\n // \"chat_id\": 453\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.api.caleida.io/chats/get_chat_detail/?project_id={{project_id}}","protocol":"https","host":["core","api","caleida","io"],"path":["chats","get_chat_detail",""],"query":[{"key":"project_id","value":"{{project_id}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 05:55:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"091741c0116c4fe99a2fe93f991d3eec"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": null,\n \"suid\": null\n}"}],"_postman_id":"a5be7345-8823-4702-80d8-bce1065d739d"},{"name":"Send Message in a chat","id":"5f9caaf0-dd03-439b-800f-9fae5da6f203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"message\": \"Hey how are you i am raj.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/chats/records/{{chat_id}}/send_message/","urlObject":{"protocol":"https","path":["chats","records","{{chat_id}}","send_message",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"ee170888-5e2e-4a4d-b7fb-9bd012d1bffb","name":"Send Message in a chat","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"message\": \"Hey how are you i am raj.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/chats/records/{{chat_id}}/send_message/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"detail\": \"{\\\"sent\\\":true}\"\n}"}],"_postman_id":"5f9caaf0-dd03-439b-800f-9fae5da6f203"},{"name":"Create","id":"5c3cc378-856a-4bad-bf7f-7c339e060809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"project\": \"5107cad5-3610-413c-bcea-a92c009824ca\",\n \"auto\": false,\n \"user_details\": {\n \"meta\": {\n \"hobby\":\"gardening, playing football\"\n },\n \"name\": \"O6XX97\",\n \"email\": null\n },\n \"channel\": \"green-api\",\n \"suid\": \"8348489129@c.us\"\n \n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/chats/records/","urlObject":{"protocol":"https","path":["chats","records",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c3cc378-856a-4bad-bf7f-7c339e060809"}],"id":"e2b45b38-0e5f-4d24-909b-8f150ede695f","description":"

Chat and Message API Management

This section provides robust APIs designed for managing chats and messages within the Caleida platform, facilitating seamless communication and interaction:

Chat Management

Get Chats 📋
\n
- Description: Retrieve the list of chats available within the platform.
\n
Get One Chat 🔍
\n
- Description: Retrieve detailed information about a specific chat using its unique ID.
\n
Chat Settings ⚙️
\n
- Description: Configure chat settings, such as enabling or disabling agents, managing notifications, and setting chat priorities.
\n
Get Chat Stats 📊
\n
- Description: Retrieve detailed statistics on chat activities, including active chats, average response times, and user engagement levels.
\n
Get Message Stats 📈
\n
- Description: Access comprehensive statistics on messaging, such as message volume, delivery rates, and interaction metrics.
\n

Message Management

Send Messages ✉️
\n
- Description: Send various types of messages within chats using this API.
\n
Message History 📜
\n
- Description: Access and manage the history of messages exchanged within chats.
\n
Delete Message 🗑️
\n
- Description: Delete specific messages from a chat using this API.
\n
Download Document 📄
\n
- Description: Download documents shared within messages using this API.
\n

These APIs empower developers to create, manage, and optimize chat and messaging functionalities within Caleida, ensuring a seamless and engaging user experience across various communication channels.

For more details, visit the Caleida dashboard.

\n","_postman_id":"e2b45b38-0e5f-4d24-909b-8f150ede695f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Bot","item":[{"name":"Project","item":[{"name":"Subscription & Quota","item":[{"name":"Get Quota","id":"9a2f2ada-5faa-40fc-b501-af4edf69f8b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/bots/projects/{{project_id}}/quota/","description":"

This endpoint retrieves the quota information for a specific project. The response of this request can be documented as a JSON schema to provide a clear structure of the quota data.

This endpoint retrieves the subscription details for a specific project.

The response of this request can be documented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"subscription_id\": {\n      \"type\": \"string\"\n    },\n    \"status\": {\n      \"type\": \"string\"\n    },\n    \"start_date\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"end_date\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    }\n  }\n}\n\n

Create Checkout Session Subscription

This endpoint allows the creation of a checkout session for a subscription within a specific project.

Request Body

plan_id (string): The ID of the plan for the subscription.
\n
success_url (string): The URL to redirect to after a successful transaction.
\n
cancel_url (string): The URL to redirect to if the transaction is canceled.
\n

Response
The response will contain the details of the created checkout session.

This endpoint makes an HTTP GET request to retrieve the customer portal URL for a specific project. The project_id parameter in the URL path identifies the project, and the return_url query parameter specifies the URL to which the customer will be redirected after accessing the portal.

Request Body

This request does not contain a request body.

Response Body

The response will contain the customer portal URL for the specified project.

This endpoint makes an HTTP GET request to upgrade the subscription for a specific project. The request should include a payload in the raw request body type, with the \"plan_id\" key to specify the ID of the plan to which the subscription should be upgraded.

The response will include the details of the upgraded subscription, such as the plan details and any relevant subscription information.

Subscription and Quota Management

This section provides comprehensive tools for managing your subscription plans, quotas, and usage details within Caleida:

Managing Subscription Plans

Upgrade or Downgrade 🔁
\n
- Description: Easily adjust your subscription plan to meet changing needs.
\n
Plan Details 📋
\n
- Description: Access detailed information about your current plan, including features and limitations.
\n
Billing History 🧾
\n
- Description: View past invoices and payment details for your subscription.
\n

Quota Management

Credit Monitoring 📊
\n
- Description: Track usage credits and remaining balances.
\n
Usage Details 📈
\n
- Description: View detailed usage reports to monitor resource consumption.
\n
Alerts and Notifications 🚨
\n
- Description: Set up alerts for reaching usage limits or upcoming renewals.
\n

New Plan Setup

Selecting Plans 📝
\n
- Description: Choose from a variety of subscription plans tailored to your business requirements.
\n
Customization Options 🛠️
\n
- Description: Explore options to customize plans based on specific needs.
\n
Implementation Support 🤝
\n
- Description: Get assistance with setting up new plans and integrating them into your workflow.
\n

Accessing Features

Feature Activation ✨
\n
- Description: Manage and activate features associated with your subscription plan.
\n
API Access 🌐
\n
- Description: Ensure seamless integration with API access management tools.
\n
Support and Documentation 📚
\n
- Description: Access comprehensive support resources and documentation to maximize plan benefits.
\n

This section empowers you to effectively manage your subscription, monitor usage, and optimize your Caleida experience according to your business goals.

For more details, visit the Caleida dashboard.

\n","_postman_id":"6d5d0b95-2929-421a-b3cc-81145e9204ba","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Insight-Email-Requests","item":[{"name":"Create","id":"51a24b64-3307-4409-9244-3ad9cc1e1c7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"start_date\": \"2024-04-01T10:13:20Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/bots/projects/{{project_id}}/insight-email-requests/","description":"

This endpoint allows you to create insight email requests for a specific project.

The request should be sent as an HTTP POST to {{base_url}}/bots/projects/{{project_id}}/insight-email-requests/ with a JSON payload in the raw request body type. The payload should include the \"start_date\" parameter.

Response

The response will be in the form of a JSON object with the following properties:

\"id\" (string): The ID of the insight email request.
\n
\"created\" (string): The timestamp indicating when the request was created.
\n
\"modified\" (string): The timestamp indicating when the request was last modified.
\n
\"status\" (string): The status of the request.
\n
\"error\" (null or string): If an error occurred, this will contain the error message.
\n
\"start_date\" (string): The start date provided in the request.
\n
\"end_date\" (null or string): The end date for the request, if provided.
\n
\"includes\" (null or array): An array of included items, if any.
\n
\"campaign_id\" (null or string): The ID of the campaign associated with the request, if any.
\n
\"user\" (string): The user associated with the request.
\n
\"project\" (string): The project associated with the request.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"created\": {\"type\": \"string\"},\n    \"modified\": {\"type\": \"string\"},\n    \"status\": {\"type\": \"string\"},\n    \"error\": {\"oneOf\": [{\"type\": \"null\"}, {\"type\": \"string\"}]},\n    \"start_date\": {\"type\": \"string\"},\n    \"end_date\": {\"oneOf\": [{\"type\": \"null\"}, {\"type\": \"string\"}]},\n    \"includes\": {\"oneOf\": [{\"type\": \"null\"}, {\"type\": \"array\"}]},\n    \"campaign_id\": {\"oneOf\": [{\"type\": \"null\"}, {\"type\": \"string\"}]},\n    \"user\": {\"type\": \"string\"},\n    \"project\": {\"type\": \"string\"}\n  }\n}\n\n

This endpoint makes an HTTP GET request to retrieve insight email requests for a specific project. The response for this request is a JSON schema representing the structure of the data returned.

This endpoint retrieves the insight email request details for a specific project and request ID. The response for this request can be represented as a JSON schema as follows:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"request_id\": {\n      \"type\": \"string\"\n    },\n    \"project_id\": {\n      \"type\": \"string\"\n    },\n    \"insight_id\": {\n      \"type\": \"string\"\n    },\n    \"email\": {\n      \"type\": \"string\"\n    },\n    \"status\": {\n      \"type\": \"string\"\n    },\n    \"created_at\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"updated_at\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    }\n  }\n}\n\n

Delete Insight Email Request

This endpoint is used to delete a specific insight email request for a project.

Request Body

This endpoint does not require a request body.

Response

Upon a successful deletion, the response will not include a body, but will return a 204 No Content status code.

📧 Sending Insight Results via User-Registered Email Routes

This section outlines the routes and functionalities for sending insight results to users via their registered email addresses within the Caleida platform

\n","_postman_id":"cadc102b-c145-4eb8-bcc7-e6ed3c2d36a4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Get","id":"e0f2dd00-806c-4303-9c0c-e72ece059c97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/bots/projects/","description":"

This endpoint makes an HTTP GET request to retrieve a list of projects related to bots. The request does not require a request body, and the response will include an array of project objects, each containing details such as project ID, name, and other relevant information.

Update Bot Project Details

This endpoint allows the user to update the details of a specific bot project.

Request

Method: PATCH
\n
URL: {{base_url}}/bots/projects/{{project_id}}/
\n

Request Body

name (string, optional): The updated name of the bot project.
\n
template (string, optional): The updated template for the bot project.
\n

Response

The response for this request is a JSON schema that represents the structure of the updated bot project details.

This endpoint makes an HTTP PATCH request to update the flow configuration of a specific project's bot. The request body should contain a JSON payload with the updated flow configuration, including the theme primary color.

Response

The response of this request is a JSON object representing the updated flow configuration of the project's bot. To document the response as a JSON schema, the schema definition for the response object can be generated based on the actual response received from the API.

Update Bot Project

This endpoint is used to update a specific bot project by its ID.

Request Body

name (string, optional): The name of the bot project.
\n
flow_config (object): The configuration for the bot project's flow.
\n

Example:

{\n  \"name\": \"\",\n  \"flow_config\": {\n    \"hello\": {},\n    \"hello_world\": null\n  }\n}\n\n

Response

The response will contain the updated details of the bot project.

Create New Bot Project

This API endpoint allows the user to create a new bot project.

Request Body

description: (string) A brief description of the bot project.
\n
spc: (string) The specific category of the bot project.
\n
website_url: (string) The URL of the website associated with the bot project.
\n

Response

The response of this request is a JSON object conforming to the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"string\"\n    },\n    \"message\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\n          \"type\": \"string\"\n        },\n        \"name\": {\n          \"type\": \"string\"\n        },\n        \"active\": {\n          \"type\": \"boolean\"\n        },\n        \"spc\": {\n          \"type\": \"string\"\n        },\n        \"website_url\": {\n          \"type\": \"string\"\n        },\n        \"description\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

Get Project Details

This endpoint retrieves the details of a specific project.

Request

Method: GET
\n
URL: {{base_url}}/bots/projects/{{project_id}}/
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"project_id\": {\n      \"type\": \"string\"\n    },\n    \"project_name\": {\n      \"type\": \"string\"\n    },\n    \"created_at\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"updated_at\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"description\": {\n      \"type\": \"string\"\n    },\n    \"owner\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"user_id\": {\n          \"type\": \"string\"\n        },\n        \"username\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

Delete Bot Project

This endpoint is used to delete a specific bot project.

Request

Method: DELETE
\n
Endpoint: {{base_url}}/bots/projects/{{project_id}}
\n
Headers:
\n
- Content-Type: application/json
\n
Body:
\n
```
{\n  \"confirm\": \"\"\n}\n\n
```
\n

Response

The response for this request is not available as a JSON schema.

\n","urlObject":{"protocol":"https","path":["bots","projects","{{project_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9bbe5665-c007-4855-a13a-ab8049348759"},{"name":"Template","id":"3237ed99-f1ff-4b08-b3e1-548c6174403d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/bots/projects/{{project_id}}/template/","description":"

This endpoint retrieves the template for a specific project identified by the project ID. The request does not require a request body as it is a GET method. The response will include the template details for the specified project, such as the template ID, name, and other relevant information.

Get Project Flow

This endpoint retrieves the flow for a specific project.

Request

Method: GET
\n
URL: {{base_url}}/bots/projects/{{project_id}}/flow/
\n

Response

The response for this request can be documented as a JSON schema. The schema should include the properties and their types as per the response body.

This endpoint makes an HTTP GET request to retrieve the theme details for a specific project.

Request Body

This request does not require a request body.

Response

Upon a successful request, the response will include the theme details for the specified project.

Project API Management

This section encompasses a suite of APIs dedicated to managing projects within Caleida, including subscriptions, quotas, and various project-related functionalities:

Subscription Management

Upgrade or Downgrade 🔃
\n
- Description: Modify subscription plans to align with evolving project needs.
\n
Usage Monitoring 📊
\n
- Description: Track resource consumption and manage quotas effectively.
\n
Billing Insights 💳
\n
- Description: Access detailed billing information and manage payment methods.
\n

Project Operations

Create Projects 🚀
\n
- Description: Initiate new projects within Caleida’s environment.
\n
Update Projects 🛠️
\n
- Description: Modify project configurations and settings as required.
\n
Delete Projects 🗑️
\n
- Description: Safely remove projects that are no longer needed.
\n
Project Template 📄
\n
- Description: Retrieve the project template for configuration and setup.
\n

This suite of APIs enables efficient management of projects, subscriptions, and operational workflows within Caleida.

Throttle Limit : CONFIGS

\n","_postman_id":"f4af2248-192a-44f9-837f-de4450274c66","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Create","id":"c8dec905-6f79-44ed-b274-d354f99e8f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://example.com\",\n \"events\": [\n \"chat.message\",\n // \"chat\",\n // \"chat.message\",\n // \"chat.alert\",\n // \"insight.summary\",\n // \"insight.topic\",\n // \"insight.key\",\n // \"insight.conversion\",\n // \"insight.sentiment\",\n // \"campaign.goal_achieved.alert\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/bots/projects/{{project_id}}/webhooks/","description":"

POST /bots/projects/{{project_id}}/webhooks/

This endpoint allows the user to create a new webhook for a specific project.

Request Body

url (string, required): The URL to which the webhook events will be sent.
\n
events (array, required): An array of events for which the webhook should be triggered.
\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"url\": {\n      \"type\": \"string\"\n    },\n    \"events\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    }\n  }\n}\n\n

The endpoint retrieves the webhooks associated with a specific project.

The response for this request can be documented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"webhooks\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\n            \"type\": \"string\"\n          },\n          \"url\": {\n            \"type\": \"string\"\n          },\n          \"events\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"string\"\n            }\n          },\n          \"active\": {\n            \"type\": \"boolean\"\n          }\n        }\n      }\n    }\n  }\n}\n\n

This endpoint makes an HTTP GET request to retrieve information about a specific webhook within a project. The request should be made to the URL {{base_url}}/bots/projects/{{project_id}}/webhooks/{{webhook_id}}/.

Response

The response of this request is a JSON object representing the details of the specified webhook within the project. To document the response as a JSON schema, you can use the actual response received from the API as the basis for the schema definition.

Delete Bot Webhook

This endpoint is used to delete a webhook associated with a specific project and bot.

Request Parameters

project_id (string, required): The unique identifier of the project.
\n
webhook_id (string, required): The unique identifier of the webhook to be deleted.
\n

Response

The response of this request is a JSON schema representing the result of the deletion operation. The schema includes the following properties:

message (string): A message indicating the result of the deletion operation.

Example:

{\n    \"message\": \"Webhook deleted successfully.\"\n}\n\n

Update Webhook Endpoint

This endpoint allows the user to update a specific webhook for a project.

Request

Method: PATCH
\n
URL: {{base_url}}/bots/projects/{{project_id}}/webhooks/{{webhook_id}}/
\n

Request Body

Type: Raw
\n

Payload:

{\n  \"url\":\"\",\n  \"events\":[\"\"]\n}\n\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"string\"\n    },\n    \"message\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

Webhook Management API

Manage your webhooks effortlessly with these essential functionalities:

Create Webhooks 🌐
\n
- Set up HTTP callbacks to receive real-time notifications from Caleida, ensuring you stay informed without constant polling.
\n
Edit Webhooks 🛠️
\n
- Modify webhook configurations or endpoints to adapt to changing requirements or infrastructure.
\n
Delete Webhooks 🗑️
\n
- Remove webhook configurations from the system to stop notifications and clean up associated resources.
\n

These APIs provide flexibility and efficiency in managing your webhook integrations within Caleida.

Throttle Limit : CONFIGS

\n","_postman_id":"5b323238-167c-460a-a180-d9e3e35b8311","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Template","item":[{"name":"Get","id":"8b11e173-2aed-460d-9874-eadbf92b91b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/bots/templates/?ordering=-modified&public=false","description":"

This endpoint makes an HTTP GET request to retrieve a list of bot templates. The request includes parameters for ordering the results by modification date in descending order and filtering for non-public templates.

The response for this request can be documented as a JSON schema.

This endpoint makes an HTTP GET request to retrieve a list of templates for a specific bot type. The request should include the query parameter \"bot_type\" with the value \"Chat Bot\" to filter the templates accordingly.

The response will include a list of template objects, each containing details about the available chat bot templates. The response body will provide information such as template names, descriptions, and other relevant attributes for each template.

Example Request:

https://core.api.caleida.io/bots/templates/?bot_type=Chat Bot\n\n

Example Response:

{\n  \"templates\": [\n    {\n      \"template_name\": \"Template 1\",\n      \"description\": \"Description of Template 1\",\n      ...\n    },\n    {\n      \"template_name\": \"Template 2\",\n      \"description\": \"Description of Template 2\",\n      ...\n    },\n    ...\n  ]\n}\n\n

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["bots","templates",""],"host":["core","api","caleida","io"],"query":[{"key":"bot_type","value":"Chat Bot"}],"variable":[]}},"response":[{"id":"2a485458-b77f-4873-b679-e2c2b50c60a5","name":"Get With Filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/bots/templates/?bot_type=Chat Bot","protocol":"https","host":["core","api","caleida","io"],"path":["bots","templates",""],"query":[{"key":"bot_type","value":"Chat Bot"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:05:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5665"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"ad24aac63f4f44999171dda42df9ba5c"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 13,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"prompt\": \"\",\n \"comm_tone\": [],\n \"created\": \"2024-03-22T13:41:38.136668Z\",\n \"modified\": \"2024-03-22T13:41:40.724405Z\",\n \"public\": false,\n \"name\": \"SDFSDFSDF\",\n \"bot_model\": \"gpt-3.5-turbo-0125\",\n \"temp\": 100,\n \"freq_p\": 35,\n \"pres_p\": 20,\n \"spc\": \"support\",\n \"register\": null,\n \"cn\": \"SDFFSD\",\n \"cdesc\": \"SDFSFDSDFFSD\",\n \"c_contact\": \"SFDSDFSDFSDF\",\n \"owner\": \"asasd564***jNO3B\"\n }\n \n ]\n}"}],"_postman_id":"3191a821-223c-45d0-8aaf-f0e3147da874"},{"name":"Update","id":"8d80cbf1-b57b-4800-95b5-931675ea08f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"prompt","value":"sdfsafasdf","type":"text"},{"key":"spc","value":"sales","type":"text"}]},"url":"https://core.api.caleida.io/bots/templates/{{template_id}}/","description":"

This HTTP PATCH request is used to update a specific bot template identified by the template_id. The request should include the updated information for the bot template in the form-data request body.

Request Body

The request body should be in form-data format and include the updated fields for the bot template.

Response

The response will contain the updated details of the bot template after the PATCH request is processed.

Create New Bot Template

This endpoint allows the user to create a new bot template for sales agents.

Request Body

name (string): The name of the bot template.
\n
prompt (string): The prompt message for the bot template.
\n
temp (number): The temperature value.
\n
freq_p (number): The frequency value.
\n
pres_p (number): The pressure value.
\n
comm_tone (array of strings): The communication tones for the bot template.
\n
register (string): The registration details for the bot template.
\n
cn (string): The company name associated with the bot template.
\n
cdesc (string): The description of the company associated with the bot template.
\n
c_contact (string): The contact information for the company associated with the bot template.
\n

Response

The response for this request includes the following fields:

id (string): The ID of the created bot template.
\n
prompt (string): The prompt message of the bot template.
\n
comm_tone (array of strings): The communication tones of the bot template.
\n
created (string): The timestamp of creation.
\n
modified (string): The timestamp of last modification.
\n
public (boolean): The visibility status of the bot template.
\n
name (string): The name of the bot template.
\n
temp (number): The temperature value.
\n
freq_p (number): The frequency value.
\n
pres_p (number): The pressure value.
\n
spc (string): Special information.
\n
register (string): The registration details for the bot template.
\n
cn (string): The company name associated with the bot template.
\n
cdesc (string): The description of the company associated with the bot template.
\n
c_contact (string): The contact information for the company associated with the bot template.
\n
owner (string): The owner of the bot template.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"prompt\": {\"type\": \"string\"},\n    \"comm_tone\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n    \"created\": {\"type\": \"string\"},\n    \"modified\": {\"type\": \"string\"},\n    \"public\": {\"type\": \"boolean\"},\n    \"name\": {\"type\": \"string\"},\n    \"temp\": {\"type\": \"number\"},\n    \"freq_p\": {\"type\": \"number\"},\n    \"pres_p\": {\"type\": \"number\"},\n    \"spc\": {\"type\": \"string\"},\n    \"register\": {\"type\": \"string\"},\n    \"cn\": {\"type\": \"string\"},\n    \"cdesc\": {\"type\": \"string\"},\n    \"c_contact\": {\"type\": \"string\"},\n    \"owner\": {\"type\": \"string\"}\n  }\n}\n\n

This endpoint makes an HTTP GET request to retrieve information about a specific bot template identified by the template_id parameter.

Request

Request Parameters

template_id: The unique identifier of the bot template.

Response

The response will include the details of the bot template, such as its name, description, and other relevant information.

\n","urlObject":{"protocol":"https","path":["bots","templates","{{template_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"7dad43cf-7d66-4983-a6ee-eb8c64d08309","name":"Get One","originalRequest":{"method":"GET","header":[{"key":"SERVICE-BEARER-TOKEN","value":"Service 123456"}],"url":"https://core.api.caleida.io/bots/templates/{{template_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:06:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"463"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"233713b1a33443bf8f15496ed3101b46"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-22T13:41:38.136668Z\",\n \"modified\": \"2024-06-04T06:05:57.401900Z\",\n \"public\": false,\n \"name\": \"SDFSDFSDF\",\n \"prompt\": \"sdfsafasdf\",\n \"bot_model\": \"gpt-3.5-turbo-0125\",\n \"temp\": 100,\n \"freq_p\": 35,\n \"pres_p\": 20,\n \"max_tokens\": 1000,\n \"history_tokens\": 1000,\n \"kb_tokens\": 3000,\n \"spc\": \"sales\",\n \"register\": null,\n \"comm_tone\": [],\n \"cn\": \"SDFFSD\",\n \"cdesc\": \"SDFSFDSDFFSD\",\n \"c_contact\": \"SFDSDFSDFSDF\",\n \"owner\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"a4832365-7dfa-4e36-8675-ed05ff045755"},{"name":"Delete","id":"a6dffa6c-7423-41e4-91cb-c32353dbd615","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"confirm\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/bots/templates/{{template_id}}/","description":"

Delete Bot Template

This endpoint is used to delete a specific bot template.

Request Parameters

template_id (path parameter): The ID of the bot template to be deleted.

Request Body

confirm (string): A required key with an empty value to confirm the deletion.

Response

The response for this request is a JSON schema.

This section provides a detailed overview of the features related to managing templates, including creation, editing, updating, and deletion.

Template Creation 📝: Allows users to create new templates tailored to specific requirements.
\n
Template Editing 🛠️: Enables modification of existing templates to reflect changes in preferences or requirements.
\n
Template Updating 🔄: Facilitates updates to ensure templates remain current and relevant.
\n
Template Deletion 🗑️: Permanently removes outdated or unused templates to maintain organization.
\n

Throttle Limit : CONFIGS

\n","_postman_id":"3d74cb75-ee0a-4ae2-b572-5b27603f8186","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"id":"48a51b28-d566-4028-9482-de52fc186379","description":"

Project API Management

This section encompasses a suite of APIs dedicated to managing projects within Caleida, including subscriptions, quotas, and various project-related functionalities:

Subscription Management

Upgrade or Downgrade 🔃
\n
- Description: Modify subscription plans to align with evolving project needs.
\n
Usage Monitoring 📊
\n
- Description: Track resource consumption and manage quotas effectively.
\n
Billing Insights 💳
\n
- Description: Access detailed billing information and manage payment methods.
\n

Project Operations

Create Projects 🚀
\n
- Description: Initiate new projects within Caleida’s environment.
\n
Update Projects 🛠️
\n
- Description: Modify project configurations and settings as required.
\n
Delete Projects 🗑️
\n
- Description: Safely remove projects that are no longer needed.
\n

Webhook Integration

Webhook Configuration 🌐
\n
- Description: Set up and manage webhooks to receive real-time notifications and data updates.
\n
Event Handling 🔄
\n
- Description: Define webhook endpoints to handle specific events and actions.
\n

Template APIs

Template Management 📄
\n
- Description: Utilize APIs to create, update, and delete templates for consistent messaging and design.
\n
Template Customization 🎨
\n
- Description: Customize templates to align with project-specific requirements and branding guidelines.
\n

This comprehensive suite of APIs empowers you to efficiently manage projects, subscriptions, quotas, and integrate with external systems through webhooks, ensuring seamless operational workflows within Caleida.

Throttle Limit : CONFIGS

\n","_postman_id":"48a51b28-d566-4028-9482-de52fc186379","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Config","item":[{"name":"Telegram","item":[{"name":"Get","id":"5825f0d7-5bad-46de-aa3f-8ecbc789711c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/telegram/?project_id={{project_id}}","description":"

This endpoint makes an HTTP GET request to retrieve the configuration details for Telegram associated with a specific project. The request includes the project_id as a query parameter in the URL.

The response of this request can be documented as a JSON schema to provide a structured representation of the configuration details for Telegram. The JSON schema will define the expected structure of the response data, including the types and properties of the configuration attributes.

This endpoint makes an HTTP GET request to retrieve the configuration settings for a specific Telegram configuration identified by the telegram_config_id. The query parameter short=True indicates that only a summarized version of the configuration will be returned.

Response

The response of this request is a JSON object representing the configuration settings for the specified Telegram configuration. To document the response as a JSON schema, you can use the actual response data to define the schema. You may use tools like JSON Schema Generator to create a schema based on the response structure.

This endpoint allows you to update the configuration for a Telegram bot by sending an HTTP PATCH request to the specified URL. The request should include the Telegram configuration ID in the URL path. The request body should be in raw format and include the keys \"botkey\" and \"version\" for updating the bot key and version respectively.

The response will include the updated configuration details for the Telegram bot.

POST /configs/telegram/

This endpoint is used to configure Telegram settings.

Request Body

botkey (string, required): The bot key for Telegram.
\n
version (string, required): The version of the configuration.
\n
project (number, required): The project ID.
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"responseProperty1\": \"value1\",\n  \"responseProperty2\": \"value2\",\n  ...\n}\n\n

\n","urlObject":{"protocol":"https","path":["configs","telegram",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"fe9514c8-4a71-44d0-97af-35d2072e670f"},{"disabled":true,"key":"name","value":"test"},{"disabled":true,"key":"channel","value":"whatsapp"}],"variable":[]}},"response":[{"id":"0171a2d9-a966-423d-bd5e-22f123d95719","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"asasd564***jNO3B\",\n \"version\": \"asasd564***jNO3B\",\n \"project\": \"asasd564***jNO3B\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/telegram/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 09:16:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"319"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"9e6a948921b148219f29a7403562b942"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-06-04T09:16:15.273534Z\",\n \"modified\": \"2024-06-04T09:16:15.273534Z\",\n \"active\": true,\n \"token\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"polymorphic_ctype\": 26,\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"8530fc69-d727-43b3-a71e-ab8bf820321f"},{"name":"Get With Filter","id":"62f97b12-f9e9-43ef-898e-64bafcb34254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/telegram/?project={{project_id}}","description":"

This endpoint retrieves the configuration details for Telegram associated with a specific project. The request should include the project ID as a query parameter.

The response for this request can be documented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"telegram_token\": {\n      \"type\": \"string\"\n    },\n    \"chat_id\": {\n      \"type\": \"string\"\n    },\n    \"enabled\": {\n      \"type\": \"boolean\"\n    }\n  }\n}\n\n

Start Telegram Configuration

This endpoint allows the user to start a specific Telegram configuration.

Request Body

chat_id (text, required): The unique identifier for the target chat.
\n
text (text, required): The text of the message to be sent.
\n

Response

The response for this request follows the JSON schema below:

{\n    \"status\": \"string\",\n    \"message\": \"string\"\n}\n\n

This endpoint allows the user to stop a specific Telegram configuration by sending an HTTP POST request to the specified URL. The request should include the Telegram configuration ID in the URL.

Request Body

The request does not require a request body.

Response

Upon a successful request, the response will not include a response body. The status code will indicate the success of the operation.

Telegram Channel Configuration

This section details the features for managing Telegram channel configurations within the Caleida platform, covering creation, editing, deletion, starting, and stopping.

Creation 🚀: Users can create new Telegram channel configurations by defining necessary parameters such as API keys, chat IDs, and other settings.
\n
Editing 🛠️: Modify existing Telegram channel configurations to update API keys, chat IDs, or other parameters as requirements evolve.
\n
Deletion 🗑️: Permanently remove Telegram channel configurations that are no longer needed to maintain a streamlined environment.
\n
Starting ▶️: Activate a Telegram channel configuration for sending and receiving messages and notifications in real-time.
\n
Stopping ⏸️: Temporarily disable an active Telegram channel configuration for maintenance or troubleshooting purposes.
\n

Throttle Limit : CONFIGS

\n","_postman_id":"0b334fa1-7600-4291-a272-413583af69ad","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Web Channel Configuration","item":[{"name":"Get","id":"4ec086dd-cd63-4c6d-a4ac-2d3dd663284e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/web/?project_i","description":"

This endpoint makes an HTTP GET request to retrieve the web configurations. The request does not require a request body. Upon a successful request, the response will include the web configuration details.

\n","urlObject":{"protocol":"https","path":["configs","web",""],"host":["core","api","caleida","io"],"query":[{"key":"project_i","value":null}],"variable":[]}},"response":[{"id":"be542e45-1c24-47ef-88c7-ce6246d28b44","name":"Get","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/web/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:06:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2330"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"09f093b33de24b70af014032b3213cc6"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 9,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:10:54.229285Z\",\n \"modified\": \"2024-03-19T13:10:54.229285Z\",\n \"project\": \"56652dc1-c2ed-45e8-a95b-93d59369f1c4\",\n \"verification\": \"asasd564***jNO3B\",\n \"hosts\": \"\",\n \"active\": true\n }\n \n ]\n}"}],"_postman_id":"4ec086dd-cd63-4c6d-a4ac-2d3dd663284e"},{"name":"Get One","id":"cd4a4b38-37cf-4a03-b375-9d1142a85579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","web","{{web_config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"11201405-d82a-4579-93a1-bcd4b5a6c44b","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:06:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"270"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"6ca4bca08d8241d9bac1c7b6d1e92634"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:09:41.874044Z\",\n \"modified\": \"2024-06-04T05:22:12.470476Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"hosts\": \"127.0.0.1,baliza.io\",\n \"active\": false\n}"}],"_postman_id":"cd4a4b38-37cf-4a03-b375-9d1142a85579"},{"name":"Update","id":"ca7c9ada-afee-4898-ae74-32268ae0a8ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"hosts\": \"***\",\n \"version\": \"**\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","web","{{web_config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"3d618212-0292-47d7-ac73-9bc9e0dca361","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"hosts\": \"asasd564***jNO3B\",\n \"version\": \"asasd564***jNO3B\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:07:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"270"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"141238e8a57d4f0fad1f380f4dc3ab6c"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:09:41.874044Z\",\n \"modified\": \"2024-06-04T06:07:00.864802Z\",\n \"project\": \"6ca6e140-f01f-4210-a2e5-3c6c4b9bb67b\",\n \"verification\": \"asasd564***jNO3B\",\n \"hosts\": \"127.0.0.1,baliza.io\",\n \"active\": false\n}"}],"_postman_id":"ca7c9ada-afee-4898-ae74-32268ae0a8ff"},{"name":"Create","id":"6aa50c1a-eba3-497c-997d-3c96be9355b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"hosts\": \"\",\n \"project\": \"670a0d93-9a7f-4c82-bbc7-5f59735fa5d6\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/web/","urlObject":{"protocol":"https","path":["configs","web",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"q","value":"gmail"}],"variable":[]}},"response":[{"id":"32d350b7-21f1-4fd1-8069-ad373e657d4f","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"hosts\": \"127.0.0.1,***.io\",\n \"project\": \"asasd564***jNO3B\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/web/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:10:54.229285Z\",\n \"modified\": \"2024-03-19T13:10:54.229285Z\",\n \"project\": \"56652dc1-c2ed-45e8-a95b-93d59369f1c4\",\n \"verification\": \"asasd564***jNO3B\",\n \"hosts\": \"\",\n \"active\": true\n}"}],"_postman_id":"6aa50c1a-eba3-497c-997d-3c96be9355b0"},{"name":"Get With Filter","id":"26339576-03b2-48c8-800c-6757dc044c14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/web/?project_id={{project_id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","web",""],"host":["core","api","caleida","io"],"query":[{"key":"project_id","value":"{{project_id}}"}],"variable":[]}},"response":[{"id":"4f8b85eb-8a9f-4d51-b7dc-312421a81922","name":"Get With Filter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/configs/web/?project_id={{project_id}}","protocol":"https","host":["core","api","caleida","io"],"path":["configs","web",""],"query":[{"key":"project_id","value":"{{project_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:07:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"322"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"c7f20537ead6498789137f0b558191da"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:09:41.874044Z\",\n \"modified\": \"2024-06-04T06:07:00.864802Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"hosts\": \"asasd564***jNO3B\",\n \"active\": false\n }\n ]\n}"}],"_postman_id":"26339576-03b2-48c8-800c-6757dc044c14"},{"name":"Start","id":"a5a95546-f587-4bbe-b8d1-a852a634ce5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/start/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","web","{{web_config_id}}","start",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"0ffe9adc-b752-4c5a-b5b7-b39850a7823a","name":"Start","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/start/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:07:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"269"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"11cb72b74e8b41e480d4585d6a3fd05b"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:09:41.874044Z\",\n \"modified\": \"2024-06-04T06:07:53.388815Z\",\n \"project\":\"asasd564***jNO3B\",\n \"verification\":\"asasd564***jNO3B\",\n \"hosts\": \"127.0.0.1,baliza.io\",\n \"active\": true\n}"}],"_postman_id":"a5a95546-f587-4bbe-b8d1-a852a634ce5f"},{"name":"Stop","id":"03d5e6f4-1471-4c05-aab6-67384a993639","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/stop/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","web","{{web_config_id}}","stop",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"9e25ab5e-e56c-4c53-af7e-b46a9d8b1c58","name":"Stop","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/web/{{web_config_id}}/stop/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:08:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"270"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"b86bfc4ea8104d0bbd81c7832e043760"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-03-19T13:09:41.874044Z\",\n \"modified\": \"2024-06-04T06:08:27.410182Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"hosts\": \"127.0.0.1,baliza.io\",\n \"active\": false\n}"}],"_postman_id":"03d5e6f4-1471-4c05-aab6-67384a993639"}],"id":"8dfe5035-b6e7-4c5b-8d69-223c2d64ed0a","description":"

Creation 🌐: Users can create new web channel configurations by specifying parameters such as endpoint URLs, authentication tokens, and other settings.
\n
Editing 🛠️: Modify existing web channel configurations to update endpoint URLs, authentication tokens, or other parameters as needed.
\n
Deletion 🗑️: Permanently remove web channel configurations that are no longer necessary to maintain a streamlined environment.
\n
Starting ▶️: Activate a web channel configuration for sending and receiving data or notifications via webhooks.
\n
Stopping ⏸️: Temporarily disable an active web channel configuration for maintenance or troubleshooting purposes.
\n

\n","_postman_id":"8dfe5035-b6e7-4c5b-8d69-223c2d64ed0a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Whatsapp","item":[{"name":"Get","id":"28b488c5-ea76-4018-a659-a7546d30e584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"89ac75ea-71d5-4865-853a-0b203f2a0513","name":"Get","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:08:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"728"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"a66fce32ac8e436c8f25b366797f1ec9"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-04-03T13:35:00.199630Z\",\n \"modified\": \"2024-06-04T05:23:21.689599Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"token\": \"asasd564***jNO3B\",\n \"phoneNoId\": \"asasd564***jNO3B\",\n \"secret\": \"asasd564***jNO3B\",\n \"business_id\": \"147439955108289\",\n \"active\": false,\n \"webhook_url\": \"https://bots.stage.services.caleida.io/api/v1/whatsapp/webhook/asasd564***jNO3B\"\n }\n ]\n}"}],"_postman_id":"28b488c5-ea76-4018-a659-a7546d30e584"},{"name":"Get One","id":"7e2ed018-02e7-4e3d-ae25-18bc71e44655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp","{{whatsapp_config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"7b3231e3-62d6-4a11-bf91-a1eb32548654","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:08:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"676"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"ed6fd320e0444a26a32b00082eaf89f7"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-04-03T13:35:00.199630Z\",\n \"modified\": \"2024-06-04T05:23:21.689599Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"token\": \"asasd564***jNO3B\",\n \"phoneNoId\": \"**\",\n \"secret\": \"*****\",\n \"business_id\": \"***\",\n \"active\": false,\n \"webhook_url\": \"https://bots.stage.services.caleida.io/api/v1/whatsapp/webhook/asasd564***jNO3B\"\n}"}],"_postman_id":"7e2ed018-02e7-4e3d-ae25-18bc71e44655"},{"name":"Get Templates","id":"5563d437-469c-4699-bf1e-38d82b4cf91f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/templates/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp","{{whatsapp_config_id}}","templates",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"994a488f-75f6-4998-b0d9-acddf09cdd58","name":"Get Templates","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/templates/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1689"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"10577bf81a2646a28c13326cacccd213"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"car_interest_campaign\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Hey, We actually found it for you.\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hello {{1}},\\nAs per our last interaction, you showed interest in {{3}} and we found it. A {{2}} {{3}} in great condition as per your request. \\nThe seller is ready to sell it for {{4}}, which is negotiable.\\nIf you are still interested in it let us know.\",\n \"example\": {\n \"body_text\": [\n [\n \"Raj\",\n \"2018\",\n \"Toyota Fortuner XLR\",\n \"$54,000\"\n ]\n ]\n }\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Yes, Let's us talk.\"\n }\n ]\n }\n ],\n \"language\": \"en\",\n \"status\": \"APPROVED\",\n \"category\": \"MARKETING\",\n \"id\": \"1118266965959088\"\n },\n {\n \"name\": \"concesur\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Welcome\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hola {{1}}, te contacto desde Concesur. Eres una de las personas que aparece en nuestra base de datos clientes. Tenemos una nueva IA que quiere hablar contigo para ofrecerte un oferta excepcional. ¿Te interesa?\",\n \"example\": {\n \"body_text\": [\n [\n \"Raj\"\n ]\n ]\n }\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"What's new?\"\n }\n ]\n }\n ],\n \"language\": \"es\",\n \"status\": \"APPROVED\",\n \"category\": \"MARKETING\",\n \"id\": \"250150018154347\"\n },\n {\n \"name\": \"hello_world\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Hello World\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Welcome and congratulations!! This message demonstrates your ability to send a WhatsApp message notification from the Cloud API, hosted by Meta. Thank you for taking the time to test with us.\"\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"WhatsApp Business Platform sample message\"\n }\n ],\n \"language\": \"en_US\",\n \"status\": \"APPROVED\",\n \"category\": \"UTILITY\",\n \"id\": \"626095083010887\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"MAZDZD\",\n \"after\": \"MjQZD\"\n }\n }\n}"}],"_postman_id":"5563d437-469c-4699-bf1e-38d82b4cf91f"},{"name":"Update","id":"b4b4e846-4499-491f-a775-da81b25a20e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"business_id\": \"***\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp","{{whatsapp_config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"5302c1a2-147d-41eb-8fa2-771779d59770","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"business_id\": \"asasd564***jNO3B\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"676"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"ef815d8f5fad486189cbe2a5d7c8694a"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-04-03T13:35:00.199630Z\",\n \"modified\": \"2024-06-04T06:09:09.360324Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"token\": \"asasd564***jNO3B\",\n \"phoneNoId\": \"asdasdasdasdasdasdas\",\n \"secret\": \"dasdasdasdasdasdasdasdBusiness account d\",\n \"business_id\": \"147439955108289\",\n \"active\": false,\n \"webhook_url\": \"https://bots.stage.services.caleida.io/api/v1/whatsapp/webhook/asasd564***jNO3B\"\n}"}],"_postman_id":"b4b4e846-4499-491f-a775-da81b25a20e6"},{"name":"Create","id":"884e180c-2a0d-41f2-95c0-b63268fc087e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"appId\": \"\",\n \"phoneNoId\": \"\",\n \"secret\": \"\",\n \"project\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/whatsapp/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"884e180c-2a0d-41f2-95c0-b63268fc087e"},{"name":"Get With Filter","id":"c0225e18-dfdb-41e8-9703-24b8e09e8908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/?project={{project_id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp",""],"host":["core","api","caleida","io"],"query":[{"key":"project","value":"{{project_id}}"}],"variable":[]}},"response":[{"id":"a1c303b8-14e1-4486-b950-4dacb1aee9e3","name":"Get With Filter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/configs/whatsapp/?project={{project_id}}","protocol":"https","host":["core","api","caleida","io"],"path":["configs","whatsapp",""],"query":[{"key":"project","value":"{{project_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"728"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"d1ca3cbae6d440debca29032b2b2b054"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-04-03T13:35:00.199630Z\",\n \"modified\": \"2024-06-04T06:09:09.360324Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"token\": \"asasd564***jNO3B\",\n \"phoneNoId\": \"asdasdasdasdasdasdas\",\n \"secret\": \"dasdasdasdasdasdasdasdBusiness account d\",\n \"business_id\": \"asasd564***jNO3B\",\n \"active\": false,\n \"webhook_url\": \"https://bots.stage.services.caleida.io/api/v1/whatsapp/webhook/asasd564***jNO3B\"\n }\n ]\n}"}],"_postman_id":"c0225e18-dfdb-41e8-9703-24b8e09e8908"},{"name":"Start","id":"620d9dda-1b91-4213-84c8-4952bdab7cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/start/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp","{{whatsapp_config_id}}","start",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"3d238e60-1a67-4ee1-bd8e-5a8220185a7d","name":"Start","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/start/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"675"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"07d30e3ea13b4c4bbc0d91b6e888fbae"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-04-03T13:35:00.199630Z\",\n \"modified\": \"2024-06-04T06:09:28.034556Z\",\n \"project\": \"asasd564***jNO3B\",\n \"verification\": \"asasd564***jNO3B\",\n \"token\": \"asasd564***jNO3B\",\n \"phoneNoId\": \"asdasdasdasdasdasdas\",\n \"secret\": \"dasdasdasdasdasdasdasdBusiness account d\",\n \"business_id\": \"147439955108289\",\n \"active\": true,\n \"webhook_url\": \"https://bots.stage.services.caleida.io/api/v1/whatsapp/webhook/asasd564***jNO3B\"\n}"}],"_postman_id":"620d9dda-1b91-4213-84c8-4952bdab7cb1"},{"name":"Stop","id":"365b09d6-5a9c-4545-b50c-8e3a078640d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/whatsapp/{{whatsapp_config_id}}/stop/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","whatsapp","{{whatsapp_config_id}}","stop",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"365b09d6-5a9c-4545-b50c-8e3a078640d0"}],"id":"8774f898-f753-4309-b2ce-c092ef526a78","description":"

WhatsApp Channel Configuration

This section outlines the features for managing WhatsApp channel configurations within the Caleida platform, covering the creation, editing, deletion, starting, and stopping.

Creation 📲: Users can create new WhatsApp channel configurations by specifying essential parameters such as phone numbers, API keys, authentication tokens, and other relevant settings. This feature allows users to set up WhatsApp channels tailored to their specific messaging and notification needs.
\n
Editing 🛠️: Existing WhatsApp channel configurations can be modified to update phone numbers, API keys, authentication tokens, or other configuration parameters. The editing feature provides flexibility, enabling users to adjust their WhatsApp channel setups as requirements evolve.
\n
Deletion 🗑️: WhatsApp channel configurations that are no longer needed can be permanently deleted. This feature helps maintain a streamlined configuration environment by allowing users to remove outdated or unnecessary WhatsApp channels, ensuring only active and relevant configurations remain.
\n
Starting ▶️: Users can start a WhatsApp channel configuration to activate it for sending and receiving messages and notifications through WhatsApp. Starting a configuration enables real-time communication via the configured WhatsApp channel.
\n
Stopping ⏸️: Users have the option to stop an active WhatsApp channel configuration, temporarily disabling its functionality. This feature is useful for maintenance, troubleshooting, or when the WhatsApp channel needs to be temporarily paused without deleting its configuration.
\n

\n","_postman_id":"8774f898-f753-4309-b2ce-c092ef526a78","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Slack","item":[{"name":"Authorize","id":"bca4a782-fd9b-466c-bcf8-bb9f1a278dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/slack/authorize/{{project_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","slack","authorize","{{project_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"3edf73be-1fdd-4adf-9937-9263dee2062f","name":"Authorize","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/slack/authorize/{{project_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"258"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"0a5dad8e6311493e8863299b648415d1"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://slack.com/***\"\n}"}],"_postman_id":"bca4a782-fd9b-466c-bcf8-bb9f1a278dee"},{"name":"Get One By Team ID","id":"b94df68c-344e-49d8-ae83-40bb347a86b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"SERVICE-BEARER-TOKEN","value":"Service 123456"}],"url":"https://core.api.caleida.io/configs/slack/{{team_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","slack","{{team_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"492bd5a1-7dc2-4f64-a239-2c3c024171b6","name":"Get One By Team ID","originalRequest":{"method":"GET","header":[{"key":"SERVICE-BEARER-TOKEN","value":"Service 123456"}],"url":"https://core.api.caleida.io/configs/slack/{{team_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"208"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"181c2b025ea54d24940f0e1b1d5fa41c"}],"cookie":[],"responseTime":null,"body":"{\n \"bot_token\": \"asasd564***jNO3B\",\n \"bot_user_id\": \"asasd564***jNO3B\",\n \"project\": \"asasd564***jNO3B\",\n \"active\": true,\n \"id\":\"asasd564***jNO3B\"\n}"}],"_postman_id":"b94df68c-344e-49d8-ae83-40bb347a86b4"},{"name":"Get","id":"6fab4fb6-c45b-4e36-9d75-848b447ac43a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"https://core.api.caleida.io/configs/green-api/f4c3e053-7e4c-4e77-8522-8db30097d41/","urlObject":{"protocol":"https","path":["configs","green-api","f4c3e053-7e4c-4e77-8522-8db30097d41",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"ea3aece8-48ea-42a8-9275-a3036b4e9cc8","name":"Get","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/slack/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:09:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"184"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"80189a61d0ca44ee892a4ddb883c4332"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"team_id\": \"asasd564***jNO3B\",\n \"project\": \"asasd564***jNO3B\",\n \"active\": true\n }\n ]\n}"}],"_postman_id":"6fab4fb6-c45b-4e36-9d75-848b447ac43a"},{"name":"Start","id":"cdfba928-06a2-482a-991a-b67c938e23e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/slack/{{slack_config_id}}/start/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","slack","{{slack_config_id}}","start",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"4bce1603-8328-4d79-a2a6-13d3d7e55e81","name":"Start","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/slack/{{slack_config_id}}/start/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:10:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"137"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"9cda6ee9aec448ffb8937757c892273a"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"client_error\",\n \"errors\": [\n {\n \"code\": \"permission_denied\",\n \"detail\": \"You do not have permission to perform this action.\",\n \"attr\": null\n }\n ]\n}"}],"_postman_id":"cdfba928-06a2-482a-991a-b67c938e23e1"},{"name":"Stop","id":"267f546c-54e8-4914-a986-dd69982ed8f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/slack/{{slack_config_id}}/stop//ops/clone-project/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","slack","{{slack_config_id}}","stop","","ops","clone-project",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"98450ed6-95d4-43d7-a808-9130f44f4ed7","name":"Stop","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/slack/{{slack_config_id}}/stop/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:10:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"137"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"ca91147c80a743289aba3c90c9f1b227"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"client_error\",\n \"errors\": [\n {\n \"code\": \"permission_denied\",\n \"detail\": \"You do not have permission to perform this action.\",\n \"attr\": null\n }\n ]\n}"}],"_postman_id":"267f546c-54e8-4914-a986-dd69982ed8f9"}],"id":"d2f0014d-fefe-4545-8d18-8eec1ffdd13a","description":"

Slack Channel Configuration

This section outlines the features for managing Slack channel configurations within the Caleida platform, covering creation, editing, deletion, starting, and stopping.

Creation 🖥️: Users can create new Slack channel configurations by specifying essential parameters such as workspace tokens, channel IDs, webhook URLs, and other relevant settings. This feature allows users to set up Slack channels tailored to their specific messaging and notification needs.
\n
Editing 🛠️: Existing Slack channel configurations can be modified to update workspace tokens, channel IDs, webhook URLs, or other configuration parameters. The editing feature provides flexibility, enabling users to adjust their Slack channel setups as requirements evolve.
\n
Deletion 🗑️: Slack channel configurations that are no longer needed can be permanently deleted. This feature helps maintain a streamlined configuration environment by allowing users to remove outdated or unnecessary Slack channels, ensuring only active and relevant configurations remain.
\n
Starting ▶️: Users can start a Slack channel configuration to activate it for sending and receiving messages and notifications through Slack. Starting a configuration enables real-time communication via the configured Slack channel.
\n
Stopping ⏸️: Users have the option to stop an active Slack channel configuration, temporarily disabling its functionality. This feature is useful for maintenance, troubleshooting, or when the Slack channel needs to be temporarily paused without deleting its configuration.
\n

\n","_postman_id":"d2f0014d-fefe-4545-8d18-8eec1ffdd13a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Email (sendGrid)","item":[{"name":"Get","id":"295f4644-40c2-4c6e-93c0-712a2436223a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/email/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"2938a9bb-9043-44fa-881c-65e7521e6c82","name":"Get","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/email/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"***\",\n \"active\": false,\n \"created\": \"2024-06-28T11:30:19.598438Z\",\n \"modified\": \"2024-06-28T11:30:19.598438Z\",\n \"api_key\": \"***\",\n \"hostname\": \"\",\n \"sender_name\": \"ABC company\",\n \"sender_email\": \"\",\n \"send_delay\": 600,\n \"ad_disc\": true,\n \"project\": \"***\"\n }\n ]\n}"}],"_postman_id":"295f4644-40c2-4c6e-93c0-712a2436223a"},{"name":"Get one","id":"e42de1d7-7a8d-4426-afcf-bea989bf4964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/email/{{config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email","{{config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"5698f42d-5902-4ad2-8b3b-9491d71b5d24","name":"Get one","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/email/{{config_id}}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"***\",\n \"active\": false,\n \"created\": \"2024-06-28T11:30:19.598438Z\",\n \"modified\": \"2024-06-28T11:30:19.598438Z\",\n \"api_key\": \"***\",\n \"hostname\": \"\",\n \"sender_name\": \"ABC company\",\n \"sender_email\": \"\",\n \"send_delay\": 600,\n \"ad_disc\": true,\n \"project\": \"***\"\n}"}],"_postman_id":"e42de1d7-7a8d-4426-afcf-bea989bf4964"},{"name":"Create","id":"3862cc17-d8f2-4f58-9e38-31a22c77a91d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"project\": \"***\",\r\n \"api_key\": \"****9130-*******-6584***\",\r\n \"sender_name\": \"ABC company\",\r\n \"send_delay\": 60, \r\n \"ad_disc\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/email/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"bae7cb46-5780-4aed-987b-ccc0c9d999e7","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"project\": \"***\",\r\n \"api_key\": \"****9130-*******-6584***\",\r\n \"sender_name\": \"ABC company\",\r\n \"send_delay\": 60, \r\n \"ad_disc\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/email/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"***\",\n \"active\": false,\n \"created\": \"2024-06-28T11:30:19.598438Z\",\n \"modified\": \"2024-06-28T11:30:19.598438Z\",\n \"api_key\": \"***\",\n \"hostname\": \"\",\n \"sender_name\": \"ABC company\",\n \"sender_email\": \"\",\n \"send_delay\": 600,\n \"ad_disc\": true,\n \"project\": \"***\"\n}"}],"_postman_id":"3862cc17-d8f2-4f58-9e38-31a22c77a91d"},{"name":"Update","id":"27c3b001-b02b-406b-b753-cf4844c043a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"hostname\": \"***\",\r\n \"sender_name\": \"ABC Infra Company\",\r\n \"sender_email\": \"***\",\r\n \"send_delay\": 60,\r\n \"ad_disc\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/email/8d5efe36-9d14-41d1-88ca-354f88be4455/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email","8d5efe36-9d14-41d1-88ca-354f88be4455",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"0e361b84-9fd3-4e3b-a3e6-1f29235c56c3","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"hostname\": \"***\",\r\n \"sender_name\": \"ABC Infra Company\",\r\n \"sender_email\": \"***\",\r\n \"send_delay\": 60,\r\n \"ad_disc\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/email/8d5efe36-9d14-41d1-88ca-354f88be4455/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"***\",\n \"active\": false,\n \"created\": \"2024-06-28T11:30:19.598438Z\",\n \"modified\": \"2024-06-28T11:30:19.598438Z\",\n \"api_key\": \"***\",\n \"hostname\": \"\",\n \"sender_name\": \"ABC company\",\n \"sender_email\": \"\",\n \"send_delay\": 600,\n \"ad_disc\": true,\n \"project\": \"***\"\n}"}],"_postman_id":"27c3b001-b02b-406b-b753-cf4844c043a5"},{"name":"Start","id":"c9aadba8-b7e6-409b-807a-f9616a44ad4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/email/{{config_id}}/start/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email","{{config_id}}","start",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"e663ef6f-2c92-4610-bf99-25e8ff353eb1","name":"Start","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/configs/email/{{config_id}}/start/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"***\",\n \"active\": true,\n \"created\": \"2024-06-28T11:30:19.598438Z\",\n \"modified\": \"2024-06-28T11:30:19.598438Z\",\n \"api_key\": \"***\",\n \"hostname\": \"\",\n \"sender_name\": \"ABC company\",\n \"sender_email\": \"\",\n \"send_delay\": 600,\n \"ad_disc\": true,\n \"project\": \"***\"\n}"}],"_postman_id":"c9aadba8-b7e6-409b-807a-f9616a44ad4a"},{"name":"Stop","id":"cf394932-68db-4680-afbf-6cb535691164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/email/{{config_id}}/stop/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email","{{config_id}}","stop",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"5a8e232c-2622-459b-a1fd-f67b4d38b3b5","name":"Stop","originalRequest":{"method":"POST","header":[],"url":"https://core.api.caleida.io/configs/email/{{config_id}}/stop/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"***\",\n \"active\": false,\n \"created\": \"2024-06-28T11:30:19.598438Z\",\n \"modified\": \"2024-06-28T11:30:19.598438Z\",\n \"api_key\": \"***\",\n \"hostname\": \"\",\n \"sender_name\": \"ABC company\",\n \"sender_email\": \"\",\n \"send_delay\": 600,\n \"ad_disc\": true,\n \"project\": \"***\"\n}"}],"_postman_id":"cf394932-68db-4680-afbf-6cb535691164"},{"name":"Get authorization doamins","id":"6ebba847-c384-4a48-a24e-b8213accbc46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/email/{{config_id}}/get_sendgrid_domains/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["configs","email","{{config_id}}","get_sendgrid_domains",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"d1e7b0cd-827f-40ec-9239-be839ab399bc","name":"Get authorization doamins","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/configs/email/{{config_id}}/get_sendgrid_domains/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 20126132,\n \"user_id\": 41294384,\n \"subdomain\": \"em9603\",\n \"domain\": \"caleida.io\",\n \"username\": \"***\",\n \"ips\": [],\n \"custom_spf\": false,\n \"default\": false,\n \"legacy\": false,\n \"automatic_security\": true,\n \"valid\": true,\n \"dns\": {\n \"mail_cname\": {\n \"valid\": true,\n \"type\": \"cname\",\n \"host\": \"***\",\n \"data\": \"***\"\n },\n \"dkim1\": {\n \"valid\": true,\n \"type\": \"cname\",\n \"host\": \"***\",\n \"data\": \"***\"\n },\n \"dkim2\": {\n \"valid\": true,\n \"type\": \"cname\",\n \"host\": \"***\",\n \"data\": \"***\"\n }\n },\n \"last_validation_attempt_at\": 1706011523\n }\n]"}],"_postman_id":"6ebba847-c384-4a48-a24e-b8213accbc46"}],"id":"073b7a05-f3ef-4964-98a1-b1ff6cc87776","description":"

Email Channel Configuration

This section outlines the features for managing email channel configurations within the Caleida platform, including creation, editing, deletion, starting, and stopping.

Creation 📧: Users can create new email channel configurations by specifying essential parameters such as SMTP server details, authentication credentials, and other relevant settings. This feature ensures that users can set up email channels tailored to their specific communication needs.
\n
Editing 🛠️: Existing email channel configurations can be modified to accommodate changes in email server settings, authentication methods, or other configuration parameters. The editing feature provides flexibility, allowing users to update their email channel configurations as needed.
\n
Deletion 🗑️: Email channel configurations that are no longer required can be permanently removed from the system. The deletion feature helps maintain an organized environment by allowing users to eliminate outdated or unnecessary configurations, ensuring only active and relevant email channels are retained.
\n
Starting ▶️: Users can start an email channel configuration to activate it for sending and receiving emails according to its defined settings. Starting a configuration enables real-time communication through the configured email channel.
\n
Stopping ⏸️: Users can stop an active email channel configuration, temporarily disabling its functionality. This feature is useful for maintenance, troubleshooting, or when the email channel needs to be temporarily suspended without deleting its configuration.
\n

\n","_postman_id":"073b7a05-f3ef-4964-98a1-b1ff6cc87776","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"id":"65182633-ac80-43ec-8640-6ff1943852e9","description":"

Channel Configuration API

This section covers the configuration of communication channels within the Caleida platform, including setup, modification, and removal.

Telegram Channel
\n
- Setup 🚀: Allows integration with Telegram for real-time messaging and notifications.
  \n
- Start ▶️: Initiates the Telegram channel for communication.
  \n
- Stop ⏹️: Halts the Telegram channel's communication.
  \n
\n
WhatsApp Channel
\n
- Setup 📱: Configures WhatsApp for messaging and notifications within the Caleida platform.
  \n
- Start ▶️: Initiates the WhatsApp channel for communication.
  \n
- Stop ⏹️: Halts the WhatsApp channel's communication.
  \n
\n
Slack Channel
\n
- Setup 💬: Integrates Slack for messaging and alerts on the Caleida platform.
  \n
- Start ▶️: Initiates the Slack channel for communication.
  \n
- Stop ⏹️: Halts the Slack channel's communication.
  \n
\n
Email Channel
\n
- Setup 📧: Enables configuration of email notifications within the Caleida platform.
  \n
- Start ▶️: Initiates the Email channel for communication.
  \n
- Stop ⏹️: Halts the Email channel's communication.
  \n
\n

Throttle Limit : CONFIGS

\n","_postman_id":"65182633-ac80-43ec-8640-6ff1943852e9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Billing","item":[{"name":"Plans","item":[{"name":"Get","id":"46c86c05-086f-4120-b927-3d192a2c2845","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/billing/plans/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["billing","plans",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"3cb6e4c1-af8d-4a9f-b7f0-836146536e8b","name":"Get","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/billing/plans/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:00:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3449"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"6887db46de4e484a896e93e09bfef438"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 10,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2023-12-06T13:02:53.872415Z\",\n \"modified\": \"2023-12-19T08:09:39.407484Z\",\n \"name\": \"Agente_IA_Elemental_Anual\",\n \"response\": 2500,\n \"document\": 1500,\n \"insight\": 100,\n \"price_id\": \"asasd564***jNO3B\",\n \"active\": true,\n \"si\": true,\n \"ci\": false,\n \"ti\": false,\n \"sai\": false,\n \"wa\": false,\n \"tg\": false,\n \"slk\": false,\n \"cam\": false\n }\n \n ]\n}"}],"_postman_id":"46c86c05-086f-4120-b927-3d192a2c2845"},{"name":"Get One","id":"2dc72c23-fb14-4686-b670-222d1340ed61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/billing/plans/{{plan_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["billing","plans","{{plan_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"73ef671b-0ebe-4add-8512-730a08ac8b78","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/billing/plans/{{plan_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:10:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"355"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"ec22de4ae8e648c196792752f0fe5f2b"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2023-12-06T13:02:53.872415Z\",\n \"modified\": \"2023-12-19T08:09:39.407484Z\",\n \"name\": \"Agente_IA_Elemental_Anual\",\n \"response\": 2500,\n \"document\": 1500,\n \"insight\": 100,\n \"price_id\": \"asasd564***jNO3B\",\n \"active\": true,\n \"si\": true,\n \"ci\": false,\n \"ti\": false,\n \"sai\": false,\n \"wa\": false,\n \"tg\": false,\n \"slk\": false,\n \"cam\": false\n}"}],"_postman_id":"2dc72c23-fb14-4686-b670-222d1340ed61"}],"id":"6bf57cdd-b5d9-42a5-a21c-b9cc40abffbd","description":"

Plan Management API

This section describes the routes for managing plans within the Caleida platform, including retrieving a list of plans and fetching details for a specific plan.

Get a List of Plans 📋
Description: Retrieves a list of all available plans in the Caleida platform. This endpoint allows users to view and compare different subscription or service plans offered.
\n
Get One Plan 🔍
Description: Fetches details for a specific plan identified by {plan_id}. This endpoint provides comprehensive information about the features, pricing, and other details associated with the requested plan.
\n

These routes enable users to effectively manage and retrieve information about plans offered by the Caleida platform.

\n","_postman_id":"6bf57cdd-b5d9-42a5-a21c-b9cc40abffbd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Checkout","item":[{"name":"New Agent Subscription","id":"3d09c533-de72-4d0f-a546-14da7f2e7d1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"plan_id\": \"*****\",\n \"success_url\": \"https://google.com\",\n \"cancel_url\": \"https://example.com\",\n \"project\": {\n \"name\": \"Agent ( AWIN )\",\n \"description\": \"sdfasdf\",\n \"spc\": \"sales\",\n \"website_url\": \"https://example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/billing/checkout/subscribe_new/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["billing","checkout","subscribe_new",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"97ef492f-d735-4300-8579-2daaf79e83eb","name":"New Agent Subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"plan_id\": \"asasd564***jNO3B\",\n \"success_url\": \"https://google.com\",\n \"cancel_url\": \"https://example.com\",\n \"project\": {\n \"name\": \"***\",\n \"description\": \"***\",\n \"spc\": \"**\",\n \"website_url\": \"https://example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/billing/checkout/subscribe_new/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:11:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"945"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"99bbd3d827754232990ab8e6e3e056b5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"****\",\n \"url\": \"https://checkout.stripe.com/c/pay/cs_test_b***\",\n \"status\": \"open\",\n \"metadata\": {\n \"customer_id\": \"asasd564***jNO3B\",\n \"document_units\": \"1500\",\n \"insight_units\": \"100\",\n \"plan_id\": \"***\",\n \"plan_name\": \"Agente_IA_Elemental_Anual\",\n \"project_create\": \"{\\\"dat**\",\n \"response_units\": \"2500\",\n \"user_id\": \"**\"\n }\n}"}],"_postman_id":"3d09c533-de72-4d0f-a546-14da7f2e7d1e"},{"name":"Get","id":"480916f3-84d5-4ef7-b2ac-3f13f320494a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/billing/checkout/{{checkout_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["billing","checkout","{{checkout_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"76a89af4-833a-4d64-8354-b8e32930604f","name":"Get","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/billing/checkout/{{checkout_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:11:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"533"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"c2a27a0241284fa8809591eb6821bf2b"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"url\": null,\n \"status\": \"expired\",\n \"metadata\": {\n \"customer_id\": \"asasd564***jNO3B\",\n \"document_units\": \"1500\",\n \"insight_units\": \"100\",\n \"plan_id\": \"asasd564***jNO3B\",\n \"plan_name\": \"Agente_IA_Elemental_Anual\",\n \"project_create\": \"{\\\"data\\\":**\",\n \"response_units\": \"2500\",\n \"user_id\": \"asasd564***jNO3B\"\n }\n}"}],"_postman_id":"480916f3-84d5-4ef7-b2ac-3f13f320494a"}],"id":"c33683d9-9d0f-4036-9206-8d8166342ab9","description":"

Agent Subscription and Checkout API

New Agent Subscription 🛒
Description: Initiates a new agent subscription in the Caleida platform. This endpoint allows users to subscribe to agent services, specifying parameters such as plan details, billing information, and other relevant data required for the subscription.
\n
Get Checkout Session 🎟️
Description: Retrieves the details of a checkout session identified by {session_id}. This endpoint provides information necessary for processing payments and completing the subscription process for agent services.
\n

These routes facilitate the management of agent subscriptions and provide the necessary functionality to initiate and complete checkout sessions within the Caleida platform.

\n","_postman_id":"c33683d9-9d0f-4036-9206-8d8166342ab9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"id":"e048a262-c523-4f7c-a3c4-dd4d508fcd7f","description":"

Subscription and Quota Management 📊

Managing Subscription Plans

Upgrade or Downgrade: Easily adjust your subscription plan to meet changing needs.
\n
Plan Details: Access detailed information about your current plan, including features and limitations.
\n
Billing History: View past invoices and payment details for your subscription.
\n

Quota Management

Credit Monitoring: Track usage credits and remaining balances.
\n
Usage Details: View detailed usage reports to monitor resource consumption.
\n
Alerts and Notifications: Set up alerts for reaching usage limits or upcoming renewals.
\n

New Plan Setup

Selecting Plans: Choose from a variety of subscription plans tailored to your business requirements.
\n
Customization Options: Explore options to customize plans based on specific needs.
\n
Implementation Support: Get assistance with setting up new plans and integrating them into your workflow.
\n

Accessing Features

Feature Activation: Manage and activate features associated with your subscription plan.
\n
API Access: Ensure seamless integration with API access management tools.
\n
Support and Documentation: Access comprehensive support resources and documentation to maximize plan benefits.
\n

This section empowers you to effectively manage your subscription, monitor usage, and optimize your Caleida experience according to your business goals.

\n","_postman_id":"e048a262-c523-4f7c-a3c4-dd4d508fcd7f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Chat Service","item":[{"name":"Send Message","event":[{"listen":"prerequest","script":{"id":"adab874f-e791-4ad5-8915-986522b9caa6","exec":["let body = this.pm.request.body.raw;","let encoded = CryptoJS.enc.Base64.stringify(CryptoJS.enc.Utf8.parse(body));","","this.pm.request.addQueryParams(`payload=${encoded}`)",""],"type":"text/javascript","packages":{}}}],"id":"a07d0a80-3197-4c3c-b749-d430da5b2088","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-channel-secret","value":"*****"}],"body":{"mode":"raw","raw":"{\n \"message\": {\n \"info\": {\n \"user\": {\n \"name\": \"raj\",\n \"email\": \"raj@baliza.io\",\n \"meta\": {\n \"some\": \"data\"\n }\n },\n \"identity\": \"userid+here\"\n },\n \"session\": \"***\",\n \"lang\": \"en\",\n \"id\": \"some_id\",\n \"type\": \"Text\",\n \"text\": \"hey\",\n \"role\": \"User\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/api/v1/web/get_response/{{chat_id}}?verify_key=****","description":"

This API can be used in order to directly integrate the bot chat feature into flutter application bypassing all the other features or any other app.

This endpoint makes an HTTP GET request to retrieve a response for a specific chat identified by the provided chat_id, along with a verify_key for authentication.

Request Body

message: Contains information about the user, session, language, message type, text, and role.
\n
- info: Contains user information, including name, email, meta data, and identity.
  \n
  - user: The user's name, email, and meta data.
    \n
  - identity: The user's identity.
    \n
  \n
- session: The session identifier.
  \n
- lang: The language of the message.
  \n
- id: The message ID.
  \n
- type: The type of message.
  \n
- text: The message text.
  \n
- role: The user's role.
  \n
\n

Response

The response contains the data related to the specific chat identified by the chat_id.

WhatsApp Proxy Send

This API endpoint allows you to send messages via WhatsApp proxy.

Request

Method: POST
\n
URL: https://core.api.caleida.io/api/v1/whatsapp/proxy_send/{{chat_id}}/
\n

Request Body

Type: Raw
\n
{ \"id\": \"some_id\", \"suid\": \"*\", \"from_name\": \"CompanyName\", \"from_user_id\": \"-\", \"extra\": { \"is_template\": true, \"template_name\": \"concesur\", \"language\": \"es\" }}
\n

Response

The response for this request is a JSON schema.

This API endpoint sends an HTTP GET request to retrieve a link preview for the provided URL. The request does not include a request body, but it includes a query parameter \"url\" which should contain the URL for which the link preview is to be retrieved.

The response will include the link preview information such as title, description, image, and other relevant details based on the provided URL.

Proxy Chat API

Send Message 📧
Description: Sends a message via proxy chat within the Caleida platform. This endpoint allows users to send text or multimedia messages to designated recipients through a proxy service, ensuring privacy and security.
\n
Get Preview Link 🔗
Description: Retrieves a preview link for shared content through proxy chat. This endpoint generates a secure URL that recipients can use to preview shared documents, images, or other media files sent via proxy chat.
\n

These routes enable users to leverage proxy chat functionality for secure and private communication within the Caleida platform.

\n","_postman_id":"660112e4-d8b8-4109-9adc-0ed5fc224e19","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Insights","item":[{"name":"Insight Config","item":[{"name":"Update","id":"54f473b7-2dc3-43e7-b02a-2597306ce173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"eu_es\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/insights/v1/insight-config/{{insight_config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","insight-config","{{insight_config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"4a3ea250-377b-4a6f-aa17-33303f68040c","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"eu_es\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/insights/v1/insight-config/{{insight_config_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:12:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"190"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"2d89a63046434e34ba5e2c5c210b33aa"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"lang\": \"eu_es\",\n \"created\": \"2024-05-30T08:18:41.487621Z\",\n \"modified\": \"2024-06-04T06:12:19.891209Z\",\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"54f473b7-2dc3-43e7-b02a-2597306ce173"},{"name":"Get One","id":"80669f9b-32ba-45fe-ab7e-f639a7697333","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"eu_es\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/insights/v1/insight-config/{{insight_config_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","insight-config","{{insight_config_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"705db374-7f60-45cd-ae23-916eea949fd7","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/insight-config/{{insight_config_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:12:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"190"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"facb5835f09c4a18a6b2ca7223546c60"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"lang\": \"eu_es\",\n \"created\": \"2024-05-30T08:18:41.487621Z\",\n \"modified\": \"2024-06-04T05:29:43.417681Z\",\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"80669f9b-32ba-45fe-ab7e-f639a7697333"},{"name":"Get List ( + Filters )","id":"d0eae4e0-1b04-4562-b212-4d34c45c6045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"lang\": \"eu_es\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/insights/v1/insight-config/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","insight-config",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"0648ff7b-d7e7-4c90-b542-8c21e2549f1b"},{"disabled":true,"key":"created__lte","value":"2023-12-19T18:05:29.745077Z"},{"disabled":true,"key":"modified__gt","value":"2023-12-19T18:05:29.745077Z"}],"variable":[]}},"response":[{"id":"14c882ee-18b6-48e9-8135-2075fc5dcc70","name":"Get List ( + Filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/insights/v1/insight-config/","protocol":"https","host":["core","api","caleida","io"],"path":["insights","v1","insight-config",""],"query":[{"key":"project","value":"0648ff7b-d7e7-4c90-b542-8c21e2549f1b","disabled":true},{"key":"created__lte","value":"2023-12-19T18:05:29.745077Z","disabled":true},{"key":"modified__gt","value":"2023-12-19T18:05:29.745077Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:11:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1746"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"58c9cd62580b4fc4a525cafe5a954e52"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 9,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"lang\": \"eu_es\",\n \"created\": \"2024-05-30T08:18:41.487621Z\",\n \"modified\": \"2024-06-04T05:29:43.417681Z\",\n \"project\": \"asasd564***jNO3B\"\n }\n \n ]\n}"}],"_postman_id":"d0eae4e0-1b04-4562-b212-4d34c45c6045"}],"id":"18859154-276a-4062-8e92-7711e9643054","description":"

Insight Configuration Management

Get One Insight Configuration 🔍
Allows users to retrieve details of a specific insight configuration. This functionality provides information about the parameters, data sources, and analysis methods configured for the insight.
\n
Get List of Insight Configurations 📋
Enables users to retrieve a list of all insight configurations available in the Caleida platform. This feature facilitates management and overview of multiple insight configurations, including summary insights, conversation insights, topic insights, sentiment insights, and key insights.
\n
Update Insight Configuration 🛠️
Allows users to update an existing insight configuration. This functionality enables modifications to parameters, data sources, and analysis methods to refine or adapt insight configurations based on evolving needs.
\n

This overview focuses on describing the functionality of managing insight configurations within the Caleida platform.

Throttle Limit : INSIGHTS

\n","_postman_id":"18859154-276a-4062-8e92-7711e9643054","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Summary Insight","item":[{"name":"Get List ( + filters )","id":"d3bad8a3-e6bc-437a-a4e3-257e7be09186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/summary-insight/?chat__campaign={{campaign_id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","summary-insight",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"{{project_id}}"},{"disabled":true,"key":"chat","value":"{{chat_id}}"},{"disabled":true,"key":"created__gt","value":"2023-12-19T18:20:08.232846Z"},{"disabled":true,"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z"},{"key":"chat__campaign","value":"{{campaign_id}}"}],"variable":[]}},"response":[{"id":"40a588b0-22d9-4572-b4ef-28bc6111b8ec","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/insights/v1/summary-insight/?chat__campaign={{campaign_id}}","protocol":"https","host":["core","api","caleida","io"],"path":["insights","v1","summary-insight",""],"query":[{"key":"chat","value":"{{chat_id}}","disabled":true},{"key":"created__gt","value":"2023-12-19T18:20:08.232846Z","disabled":true},{"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z","disabled":true},{"key":"chat__campaign","value":"{{campaign_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 09:19:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2006"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"63306f63879d4e73a7d6ee9cd36955a7"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas@lucas.com\",\n \"email\": \"lucas@lucas.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-27T10:13:19.211871Z\",\n \"modified\": \"2024-05-27T10:13:33.429885Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"title\": \"Report: Request for Cancellation Assistance\",\n \"focus\": \"The client is seeking assistance with canceling their mobile service and has expressed frustration with their current mobile phone issues.\",\n \"recom\": [\n \" Gather the client's personal information and verify their account details to proceed with the cancellation process.\",\n \" Offer alternative solutions or incentives to retain the client and address their mobile phone issues.\",\n \" Provide clear and concise instructions on the cancellation process and any associated fees or penalties.\"\n ],\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null\n },\n {\n \"id\": \"8107fe1c-602b-4d9b-9d1c-489bfdb6bab6\",\n \"chat\": {\n \"id\": \"a3932740-102b-4de3-9a79-f8694556353e\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"AlertTester 1\",\n \"email\": \"alert@testertester.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-24T15:57:55.394873Z\",\n \"modified\": \"2024-05-24T15:58:05.997554Z\",\n \"lang\": \"en\",\n \"task_id\": \"d9628789-2c97-44d1-8302-33973596358f\",\n \"status\": \"completed\",\n \"title\": null,\n \"focus\": null,\n \"recom\": [],\n \"project\": \"060fb199-7983-4731-a8a7-2932e67c02b9\",\n \"campaign\": null\n },\n {\n \"id\": \"2c1e8741-a9ef-4669-b115-36e9d36cf197\",\n \"chat\": {\n \"id\": \"97dbb421-aae6-4027-94d4-5a78bfdb7093\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas@lucas.com\",\n \"email\": \"lucas@lucas.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-24T15:37:55.290956Z\",\n \"modified\": \"2024-05-24T15:38:05.943177Z\",\n \"lang\": \"en\",\n \"task_id\": \"2c7dc3a8-040c-4b7f-bddb-ce69cf867908\",\n \"status\": \"completed\",\n \"title\": \"No Report\",\n \"focus\": \"\",\n \"recom\": [],\n \"project\": \"060fb199-7983-4731-a8a7-2932e67c02b9\",\n \"campaign\": null\n }\n ]\n}"}],"_postman_id":"d3bad8a3-e6bc-437a-a4e3-257e7be09186"},{"name":"Get One","id":"12f9508c-8756-4fb4-9771-8af893e76955","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/summary-insight/{{insight_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","summary-insight","{{insight_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"469285f9-660b-43b2-abba-fc7923180da9","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/summary-insight/{{insight_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 09:20:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"986"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"108210da26174b4d9b2f02148dbdc75c"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\":\"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas@lucas.com\",\n \"email\": \"lucas@lucas.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-27T10:13:19.211871Z\",\n \"modified\": \"2024-05-27T10:13:33.429885Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"title\": \"Report: Request for Cancellation Assistance\",\n \"focus\": \"The client is seeking assistance with canceling their mobile service and has expressed frustration with their current mobile phone issues.\",\n \"recom\": [\n \" Gather the client's personal information and verify their account details to proceed with the cancellation process.\",\n \" Offer alternative solutions or incentives to retain the client and address their mobile phone issues.\",\n \" Provide clear and concise instructions on the cancellation process and any associated fees or penalties.\"\n ],\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null\n}"}],"_postman_id":"12f9508c-8756-4fb4-9771-8af893e76955"}],"id":"29ded693-e17d-4869-8798-c15ed8ece778","description":"

Summary Insight Management

Get One Summary Insight 🔍
Allows users to retrieve details of a specific summary insight. This functionality provides concise overviews derived from aggregated data or analytics within the platform.
\n
Get List of Summary Insights 📋
Enables users to retrieve a list of all summary insights available in the Caleida platform. This feature facilitates accessing and managing multiple summary insights, providing quick access to key metrics, trends, or performance indicators.
\n

This overview focuses on describing the functionality of managing summary insights within the Caleida platform.

Throttle Limit : INSIGHTS

\n","_postman_id":"29ded693-e17d-4869-8798-c15ed8ece778","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Conversion Insight","item":[{"name":"Get List ( + filters )","id":"c6e38c32-06de-4964-8a24-37488873d5fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/conversion-insight/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","conversion-insight",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"{{project_id}}"},{"disabled":true,"key":"chat","value":"{{chat_id}}"},{"disabled":true,"key":"created__gt","value":"2023-12-19T18:20:08.232846Z"},{"disabled":true,"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z"}],"variable":[]}},"response":[{"id":"c3731d00-8781-4426-bff9-b28aa82c0b34","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/insights/v1/conversion-insight/","protocol":"https","host":["core","api","caleida","io"],"path":["insights","v1","conversion-insight",""],"query":[{"key":"project","value":"{{project_id}}","disabled":true},{"key":"chat","value":"{{chat_id}}","disabled":true},{"key":"created__gt","value":"2023-12-19T18:20:08.232846Z","disabled":true},{"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:12:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"10295"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"d67709f6a8d7444aa8fb66c58f823754"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 14,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.633152Z\",\n \"modified\": \"2024-05-31T10:43:15.942747Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"ds\": [\n \"The client's interest in making an international transfer indicates a need for a quick and efficient solution.\",\n \"The discussion of the stolen card shows urgency and a need for immediate assistance.\",\n \"The client's concern about security indicates a cautious approach to decision-making.\"\n ],\n \"cp\": 3,\n \"cpt\": \"The user has shown interest in understanding the process for making an international transfer, but there is no clear indication of interest in our specific services.\",\n \"el\": 4,\n \"elt\": \"The client's interest in understanding the process for making an international transfer shows some engagement with our company's offerings.\",\n \"recom\": [\n \"The sales team must emphasize the security measures in place for international transfers to address the client's concerns.\",\n \"It's important to provide clear and concise information about the process for making international transfers to engage the client further.\",\n \"The team should be prepared to offer assistance with the stolen card situation to demonstrate our commitment to customer support and security.\"\n ],\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null,\n \"key_insight\": \"asasd564***jNO3B\"\n },\n {\n \"id\": \"4361a20a-d5ab-4f2f-b2c8-03d0c0e66b78\",\n \"chat\": {\n \"id\": \"74723312-8df5-4954-835d-62e43914aba8\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T09:56:51.493321Z\",\n \"modified\": \"2024-05-31T09:57:15.808402Z\",\n \"lang\": \"en\",\n \"task_id\": \"8006e537-f69a-4bf1-9ce2-8ccb3574b76d\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"e73274f9-3842-4144-8c45-0168842ed971\",\n \"chat\": {\n \"id\": \"5e8f1895-7b1a-4de3-87e9-9623c1777fed\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T09:46:52.156712Z\",\n \"modified\": \"2024-05-31T09:47:39.181324Z\",\n \"lang\": \"en\",\n \"task_id\": \"5be9ac60-71e1-4a0b-98e4-346545ad3463\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"a36b80d7-47dc-4b42-9dd7-e00f863c24db\",\n \"chat\": {\n \"id\": \"3201e263-c337-40f5-b815-1800ea04e62a\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T12:16:30.866449Z\",\n \"modified\": \"2024-05-30T12:16:52.764184Z\",\n \"lang\": \"en\",\n \"task_id\": \"c25fe420-7e18-4498-a209-6a6b883d333d\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"aa537f1b-4905-42dd-bf8c-2b6b30204b20\",\n \"chat\": {\n \"id\": \"516811eb-04c1-47c8-9fdc-98c45cc683fb\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T12:16:30.944699Z\",\n \"modified\": \"2024-05-30T12:16:52.359733Z\",\n \"lang\": \"en\",\n \"task_id\": \"690a96b1-2ddf-424f-8f82-1069d911bf43\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"8aeb9f68-3162-40b3-856c-297fd22299d8\",\n \"chat\": {\n \"id\": \"9d980717-9497-4d25-bb08-d7991fb6e529\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T12:00:30.904831Z\",\n \"modified\": \"2024-05-30T12:00:52.020482Z\",\n \"lang\": \"en\",\n \"task_id\": \"d9b9045d-5c0e-4262-83dd-62ff1a3590fd\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"587d27b1-ea00-494b-a8d4-305dc2ff2cfe\",\n \"chat\": {\n \"id\": \"6ea3e4a4-3411-470c-ae8e-484cedf13a1b\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T11:56:30.804917Z\",\n \"modified\": \"2024-05-30T11:56:51.810194Z\",\n \"lang\": \"en\",\n \"task_id\": \"7b4070f9-88b7-4b8d-af59-15d3358dfd1b\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"0644140c-3532-442e-8568-93be1141f4f8\",\n \"chat\": {\n \"id\": \"6b747a53-ce12-4453-b0f9-699b98fbb358\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T10:12:30.152900Z\",\n \"modified\": \"2024-05-30T10:12:51.362595Z\",\n \"lang\": \"en\",\n \"task_id\": \"816377bb-1c4f-468e-9c20-89ca2da7a2b2\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"79583eb3-b6e8-443c-9819-e0e441bcf06b\",\n \"chat\": {\n \"id\": \"92fb55c5-3a1b-4cc9-abff-6ff27fc7e342\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T09:14:29.866788Z\",\n \"modified\": \"2024-05-30T09:14:51.380610Z\",\n \"lang\": \"en\",\n \"task_id\": \"21eace00-9ee6-492d-9bc7-17e034f30d7e\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"355fa09b-8367-4052-8ce8-70ce2fdde418\",\n \"chat\": {\n \"id\": \"0e8d2c81-6bd8-45bf-9878-ecde387ffe55\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T09:08:29.842858Z\",\n \"modified\": \"2024-05-30T09:08:53.132672Z\",\n \"lang\": \"en\",\n \"task_id\": \"f0177aa6-65c2-446c-9360-e14e39487465\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"d4ae5a46-629f-4771-b9cb-7b8107361cf2\",\n \"chat\": {\n \"id\": \"48cde3bd-5fb2-4a7a-94ef-0219577cb25f\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-30T09:02:29.859025Z\",\n \"modified\": \"2024-05-30T09:02:53.860514Z\",\n \"lang\": \"en\",\n \"task_id\": \"a3a161a1-5aa5-4961-a4ca-c3344c5acacc\",\n \"status\": \"completed\",\n \"ds\": [\n \"The client's interest in resolving the potential unauthorized transaction and credit card theft indicates a decision-making process focused on addressing these issues urgently.\"\n ],\n \"cp\": 0,\n \"cpt\": \"The user did not show any interest in buying our services.\",\n \"el\": 0,\n \"elt\": \"The client did not express any interest in our company's offerings.\",\n \"recom\": [\n \"As the client's primary concern is the potential unauthorized use of their credit card, the sales team must focus on providing assistance and guidance in resolving the issue rather than promoting our services.\"\n ],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null,\n \"key_insight\": \"2bc18dc8-ee54-428c-86ce-ab03deb4b0bd\"\n },\n {\n \"id\": \"59a92ff9-6535-46eb-8e2c-32f871e4f478\",\n \"chat\": {\n \"id\": \"524fba66-a763-4aac-96ed-508a9c9052bd\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas@lucas.com\",\n \"email\": \"lucas@lucas.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-27T10:13:19.305070Z\",\n \"modified\": \"2024-05-27T10:13:46.080957Z\",\n \"lang\": \"en\",\n \"task_id\": \"6d0dd4d8-b1be-4154-9eea-cfbcb44e939e\",\n \"status\": \"completed\",\n \"ds\": [\n \"The client's interest in canceling their service indicates a clear decision-making signal. This suggests that they have already made a decision regarding their current product and are looking to discontinue it.\"\n ],\n \"cp\": 1,\n \"cpt\": \"The user has not shown any interest in buying our services. The conversation indicates a lack of interest in exploring new services.\",\n \"el\": 2,\n \"elt\": \"The client's engagement level for our company's offering is low as they are focused on canceling their current service.\",\n \"recom\": [\n \"The sales team must address the client's concerns regarding the current service and try to understand the reasons behind the desire to cancel.\",\n \"It's important to empathize with the client's situation and offer solutions that may address their concerns and potentially retain them as a customer.\"\n ],\n \"project\": \"060fb199-7983-4731-a8a7-2932e67c02b9\",\n \"campaign\": null,\n \"key_insight\": \"84d18e61-c857-4b0a-ab95-d8734fce7c6f\"\n },\n {\n \"id\": \"076cdbbf-1ab5-43c5-8926-8944c7a00bd2\",\n \"chat\": {\n \"id\": \"a3932740-102b-4de3-9a79-f8694556353e\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"AlertTester 1\",\n \"email\": \"alert@testertester.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-24T15:57:55.431232Z\",\n \"modified\": \"2024-05-24T15:58:16.674816Z\",\n \"lang\": \"en\",\n \"task_id\": \"7546c1b8-ac82-49b1-87ce-e75c1d1d6d18\",\n \"status\": \"completed\",\n \"ds\": [],\n \"cp\": null,\n \"cpt\": \"\",\n \"el\": null,\n \"elt\": \"\",\n \"recom\": [],\n \"project\": \"060fb199-7983-4731-a8a7-2932e67c02b9\",\n \"campaign\": null,\n \"key_insight\": null\n },\n {\n \"id\": \"04f8cc94-a006-4ca8-a68a-370eff42f83d\",\n \"chat\": {\n \"id\": \"97dbb421-aae6-4027-94d4-5a78bfdb7093\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas@lucas.com\",\n \"email\": \"lucas@lucas.com\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-24T15:37:55.325245Z\",\n \"modified\": \"2024-05-24T15:38:19.787608Z\",\n \"lang\": \"en\",\n \"task_id\": \"2f9b957b-b1fa-4bae-a572-764fbb9c42cf\",\n \"status\": \"completed\",\n \"ds\": [\n \"The client's interest in purchasing a specific product.\",\n \"The client's persistence in expressing their desire to buy the product indicates a strong decision-making process.\"\n ],\n \"cp\": 8,\n \"cpt\": \"The user has shown a clear interest in buying our services, especially a specific product.\",\n \"el\": 6,\n \"elt\": \"The client's interest in purchasing a specific product from our company indicates a moderate level of engagement.\",\n \"recom\": [\n \"The sales team must address the client's concerns about the limitations of chat support and provide alternative support options.\",\n \"Given the client's strong interest and persistence, the sales team should prioritize follow-up and provide detailed information about the product to facilitate the decision-making process.\"\n ],\n \"project\": \"060fb199-7983-4731-a8a7-2932e67c02b9\",\n \"campaign\": null,\n \"key_insight\": \"79760ced-42a8-4c5a-8d81-df4edd98f39c\"\n }\n ]\n}"}],"_postman_id":"c6e38c32-06de-4964-8a24-37488873d5fd"},{"name":"Get One","id":"daccdcd2-746a-46ef-b9ac-f487736802d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/conversion-insight/{{insight_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","conversion-insight","{{insight_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"95fd6c2e-faec-4997-b09e-5bba54624939","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/conversion-insight/{{insight_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:13:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1537"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"8f272bc429a14094b219feed3236b135"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.633152Z\",\n \"modified\": \"2024-05-31T10:43:15.942747Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"ds\": [\n \"The client's interest in making an international transfer indicates a need for a quick and efficient solution.\",\n \"The discussion of the stolen card shows urgency and a need for immediate assistance.\",\n \"The client's concern about security indicates a cautious approach to decision-making.\"\n ],\n \"cp\": 3,\n \"cpt\": \"The user has shown interest in understanding the process for making an international transfer, but there is no clear indication of interest in our specific services.\",\n \"el\": 4,\n \"elt\": \"The client's interest in understanding the process for making an international transfer shows some engagement with our company's offerings.\",\n \"recom\": [\n \"The sales team must emphasize the security measures in place for international transfers to address the client's concerns.\",\n \"It's important to provide clear and concise information about the process for making international transfers to engage the client further.\",\n \"The team should be prepared to offer assistance with the stolen card situation to demonstrate our commitment to customer support and security.\"\n ],\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null,\n \"key_insight\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"daccdcd2-746a-46ef-b9ac-f487736802d4"}],"id":"ba9f46ae-8f37-4be3-8a37-fcf9444827e9","description":"

Conversation Insight Management

Get One Conversation Insight 🔍
Allows users to retrieve details of a specific conversation insight. This functionality provides analytics and metrics derived from user interactions and communication patterns within the platform.
\n
Get List of Conversation Insights 📋
Enables users to retrieve a list of all conversation insights available in the Caleida platform. This feature facilitates accessing and managing multiple conversation insights, offering insights into user engagement, communication trends, and interaction metrics.
\n

This overview focuses on describing the functionality of managing conversation insights within the Caleida platform.

Throttle Limit : INSIGHTS

\n","_postman_id":"ba9f46ae-8f37-4be3-8a37-fcf9444827e9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Topics Insight","item":[{"name":"Get List ( + filters )","id":"689962a7-eff8-4684-871f-a5df43b1c9cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/topics-insight/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","topics-insight",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"{{project_id}}"},{"disabled":true,"key":"chat","value":"{{chat_id}}"},{"disabled":true,"key":"created__gt","value":"2023-12-19T18:20:08.232846Z"},{"disabled":true,"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z"}],"variable":[]}},"response":[{"id":"991bd1bc-51af-4349-b31d-a52144e7b2c4","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/insights/v1/topics-insight/","protocol":"https","host":["core","api","caleida","io"],"path":["insights","v1","topics-insight",""],"query":[{"key":"project","value":"{{project_id}}","disabled":true},{"key":"chat","value":"{{chat_id}}","disabled":true},{"key":"created__gt","value":"2023-12-19T18:20:08.232846Z","disabled":true},{"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:13:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"10731"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"3ff0264b318648999188808b39d679d3"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 14,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.612267Z\",\n \"modified\": \"2024-05-31T10:43:03.349652Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"topics\": [\n {\n \"score\": 10,\n \"title\": \"Reporting a Stolen Card\",\n \"description\": \"The client's concern is about reporting a stolen card.\"\n },\n {\n \"score\": 9,\n \"title\": \"International Money Transfer\",\n \"description\": \"The client is interested in making an international money transfer.\"\n }\n ],\n \"keywords\": \"información de contacto, contact information, stolen card, tarjeta robada, sucursal bancaria, seguridad, servicio de atención al cliente, international transfer, security, transferencia internacional, bank branch, customer service\",\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null\n }\n \n ]\n}"}],"_postman_id":"689962a7-eff8-4684-871f-a5df43b1c9cc"},{"name":"Get One","id":"00820965-0c34-4c4b-a023-cbd719105a9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/topics-insight/{{insight_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","topics-insight","{{insight_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"b7c2eaab-c33a-43b2-bf75-6965355bbaf2","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/topics-insight/{{insight_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:13:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"942"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"339be36c120b48c188c4c5b95cce463d"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.612267Z\",\n \"modified\": \"2024-05-31T10:43:03.349652Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"topics\": [\n {\n \"score\": 10,\n \"title\": \"Reporting a Stolen Card\",\n \"description\": \"The client's concern is about reporting a stolen card.\"\n },\n {\n \"score\": 9,\n \"title\": \"International Money Transfer\",\n \"description\": \"The client is interested in making an international money transfer.\"\n }\n ],\n \"keywords\": \"información de contacto, contact information, stolen card, tarjeta robada, sucursal bancaria, seguridad, servicio de atención al cliente, international transfer, security, transferencia internacional, bank branch, customer service\",\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null\n}"}],"_postman_id":"00820965-0c34-4c4b-a023-cbd719105a9d"}],"id":"dbb79ffe-1f74-42cf-86e3-51d09d747307","description":"

Topic Insight Management

Get One Topic Insight 🔍
Allows users to retrieve details of a specific topic insight. This functionality provides analysis and trends related to specific topics or themes discussed within the platform.
\n
Get List of Topic Insights 📋
Enables users to retrieve a list of all topic insights available in the Caleida platform. This feature facilitates accessing and managing multiple topic insights, offering insights into popular discussions, trends, or recurring themes among users.
\n

This overview focuses on describing the functionality of managing topic insights within the Caleida platform.

Throttle Limit : INSIGHTS

\n","_postman_id":"dbb79ffe-1f74-42cf-86e3-51d09d747307","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Sentiment Insight","item":[{"name":"Get List ( + filters )","id":"d4f987ad-7bc8-46c3-bc91-6fec3bca1340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/sentiment-insight/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","sentiment-insight",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"{{project_id}}"},{"disabled":true,"key":"chat","value":"{{chat_id}}"},{"disabled":true,"key":"created__gt","value":"2023-12-19T18:20:08.232846Z"},{"disabled":true,"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z"}],"variable":[]}},"response":[{"id":"b8dac278-9f3e-4623-a78b-57150a259a59","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/insights/v1/sentiment-insight/","protocol":"https","host":["core","api","caleida","io"],"path":["insights","v1","sentiment-insight",""],"query":[{"key":"project","value":"{{project_id}}","disabled":true},{"key":"chat","value":"{{chat_id}}","disabled":true},{"key":"created__gt","value":"2023-12-19T18:20:08.232846Z","disabled":true},{"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:13:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"9354"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"f51e320df3244136ae23564ec3280f45"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 14,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.640587Z\",\n \"modified\": \"2024-05-31T10:43:15.157251Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"begin\": \"The client's sentiment at the start of the conversation was anxious and concerned due to the unfortunate incident of having their card stolen.\",\n \"end\": \"The client's sentiment at the end of the conversation was more reassured and hopeful as they received guidance on the process for making an international transfer and assistance with the security of their account.\",\n \"thought\": \"The overall sentiment of the conversation transitioned from anxious to reassured, with the client feeling more positive and hopeful by the end of the conversation. The client's concerns were addressed, and they received the assistance they were seeking, leading to an improved sentiment.\",\n \"sentiment\": 7,\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null,\n \"key_insight\": \"asasd564***jNO3B\"\n }\n \n ]\n}"}],"_postman_id":"d4f987ad-7bc8-46c3-bc91-6fec3bca1340"},{"name":"Get One","id":"d9c3610e-8f23-45b0-97d0-3ee210e6e9f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/sentiment-insight/{{insight_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","sentiment-insight","{{insight_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"cc8111f3-dfd8-459c-8214-02d6a4938a66","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/sentiment-insight/{{insight_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:14:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1174"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"e00123a6baeb4e47875d2f03f0ef6e59"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.640587Z\",\n \"modified\": \"2024-05-31T10:43:15.157251Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"begin\": \"The client's sentiment at the start of the conversation was anxious and concerned due to the unfortunate incident of having their card stolen.\",\n \"end\": \"The client's sentiment at the end of the conversation was more reassured and hopeful as they received guidance on the process for making an international transfer and assistance with the security of their account.\",\n \"thought\": \"The overall sentiment of the conversation transitioned from anxious to reassured, with the client feeling more positive and hopeful by the end of the conversation. The client's concerns were addressed, and they received the assistance they were seeking, leading to an improved sentiment.\",\n \"sentiment\": 7,\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null,\n \"key_insight\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"d9c3610e-8f23-45b0-97d0-3ee210e6e9f6"}],"id":"0030d513-2a5a-456f-9642-98eb57e83d93","description":"

Sentiment Insight Management

Get One Sentiment Insight 🔍
Allows users to retrieve details of a specific sentiment insight. This functionality provides analysis of the emotional tone or sentiment expressed within communications or interactions within the platform.
\n
Get List of Sentiment Insights 📋
Enables users to retrieve a list of all sentiment insights available in the Caleida platform. This feature facilitates accessing and managing multiple sentiment insights, offering insights into user sentiment, feedback, or emotional responses.
\n

This overview focuses on describing the functionality of managing sentiment insights within the Caleida platform.

Throttle Limit : INSIGHTS

\n","_postman_id":"0030d513-2a5a-456f-9642-98eb57e83d93","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Key Insight","item":[{"name":"Get List ( + filters )","id":"aff1be0e-a253-44ac-a278-5425e6aa757f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/key-insight/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","key-insight",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"{{project_id}}"},{"disabled":true,"key":"chat","value":"{{chat_id}}"},{"disabled":true,"key":"created__gt","value":"2023-12-19T18:20:08.232846Z"},{"disabled":true,"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z"}],"variable":[]}},"response":[{"id":"33ef5723-4558-44b9-90f7-58c12eb66d59","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/insights/v1/key-insight/","protocol":"https","host":["core","api","caleida","io"],"path":["insights","v1","key-insight",""],"query":[{"key":"project","value":"{{project_id}}","disabled":true},{"key":"chat","value":"{{chat_id}}","disabled":true},{"key":"created__gt","value":"2023-12-19T18:20:08.232846Z","disabled":true},{"key":"modified__lte","value":"2023-12-19T18:20:35.886656Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:15:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"7913"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"745f89c4f00c4bae97e3dbfc5dea954d"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 14,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.625233Z\",\n \"modified\": \"2024-05-31T10:43:03.132546Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"key_indicators\": [\n \"The client is interested in making an international transfer.\",\n \"The client has had their card stolen and is seeking assistance.\"\n ],\n \"concerns\": [\n \"The client's main concern is the security of their account and personal information.\"\n ],\n \"interests\": [\n \"The client is interested in understanding the process for making an international transfer.\"\n ],\n \"project\": \"asasd564***jNO3B\",\n \"campaign\": null\n }\n \n ]\n}"}],"_postman_id":"aff1be0e-a253-44ac-a278-5425e6aa757f"},{"name":"Get One","id":"bb1bcde7-3279-46f8-ae4b-5dd9e1a6802f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/key-insight/{{insight_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["insights","v1","key-insight","{{insight_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"eccb00f9-11f8-451d-ba49-77f3e4831367","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/insights/v1/key-insight/{{insight_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:15:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"789"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"b957702c89b94734a5b502d5a1c979ac"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"chat\": {\n \"id\": \"asasd564***jNO3B\",\n \"user_details\": {\n \"meta\": {},\n \"name\": \"lucas\",\n \"email\": \"lucas@caleida.io\"\n },\n \"channel\": \"web\"\n },\n \"campaign_name\": null,\n \"created\": \"2024-05-31T10:42:51.625233Z\",\n \"modified\": \"2024-05-31T10:43:03.132546Z\",\n \"lang\": \"en\",\n \"task_id\": \"asasd564***jNO3B\",\n \"status\": \"completed\",\n \"key_indicators\": [\n \"The client is interested in making an international transfer.\",\n \"The client has had their card stolen and is seeking assistance.\"\n ],\n \"concerns\": [\n \"The client's main concern is the security of their account and personal information.\"\n ],\n \"interests\": [\n \"The client is interested in understanding the process for making an international transfer.\"\n ],\n \"project\": \"7ea84747-e324-4d1d-89b6-6ee35cf349ae\",\n \"campaign\": null\n}"}],"_postman_id":"bb1bcde7-3279-46f8-ae4b-5dd9e1a6802f"}],"id":"1db8a068-6801-4fee-b2a3-8cfd6a370a8a","description":"

Key Insight Management

Get One Key Insight 🔍
Allows users to retrieve details of a specific key insight. This functionality provides important findings or actionable insights derived from data analysis within the platform.
\n
Get List of Key Insights 📋
Enables users to retrieve a list of all key insights available in the Caleida platform. This feature facilitates accessing and managing multiple key insights, offering valuable information and recommendations based on data trends, patterns, or anomalies.
\n

This overview focuses on describing the functionality of managing key insights within the Caleida platform.

Throttle Limit : INSIGHTS

\n","_postman_id":"1db8a068-6801-4fee-b2a3-8cfd6a370a8a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"id":"c3c492ae-c371-4446-a26b-4029211afb24","description":"

Insight Management

Insight Configuration ⚙️
Allows administrators to configure various types of insights such as summary insights, conversation insights, topic insights, sentiment insights, and key insights. Configuration involves setting parameters, data sources, and analysis methods to tailor insights to specific needs.
\n
Summary Insights 📊
Provides high-level summaries and overviews derived from aggregated data or analytics. Summary insights offer condensed information to provide a quick understanding of trends, performance, or other metrics relevant to the platform.
\n
Conversation Insights 💬
Focuses on insights derived from conversations within the platform. Includes analytics on communication patterns, user interactions, and engagement metrics gathered from messaging or chat data.
\n
Topic Insights 📝
Provides insights into specific topics or themes discussed within the platform. Analyzes content to identify trends, interests, or recurring subjects of discussion among users.
\n
Sentiment Insights 😊
Analyzes the sentiment expressed within conversations or interactions. Gauges the emotional tone or sentiment polarity (positive, negative, neutral) of communications to assess user sentiment or feedback.
\n
Key Insights 🔑
Highlights key findings or actionable insights derived from data analysis. Provides valuable information or recommendations based on trends, patterns, or anomalies detected within the platform's data.
\n

This overview covers the management and types of insights available within the Caleida platform, facilitating informed decision-making and strategic planning based on data-driven insights.

Throttle Limit : Insights

\n","_postman_id":"c3c492ae-c371-4446-a26b-4029211afb24","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Docs","item":[{"name":"Document Files","item":[{"name":"Get List ( + filters )","id":"0a70e5ae-b6fa-4b55-89c4-5a19aeba8033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/document-files/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","document-files",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"0648ff7b-d7e7-4c90-b542-8c21e2549f1b"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Extraction
Transformation
Pre Processing
Post Processing
Upsertion

\n","type":"text/plain"},"key":"p_status","value":"Upsertion"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Running
Completed
Failed

\n","type":"text/plain"},"key":"status","value":"Completed"},{"disabled":true,"key":"created__gte","value":"2023-12-19T09:39:54.076017Z"}],"variable":[]}},"response":[{"id":"de88f1eb-4d3a-4678-8473-32a7d00663fa","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/docs/v1/document-files/","protocol":"https","host":["core","api","caleida","io"],"path":["docs","v1","document-files",""],"query":[{"key":"project","value":"0648ff7b-d7e7-4c90-b542-8c21e2549f1b","disabled":true},{"key":"p_status","value":"Upsertion","description":"Can be any one:\n1. Pending\n2. Extraction\n3. Transformation\n4. Pre Processing\n5. Post Processing\n6. Upsertion","disabled":true},{"key":"status","value":"Completed","description":"Can be any one:\n1. Pending\n2. Running\n3. Completed\n4. Failed","disabled":true},{"key":"created__gte","value":"2023-12-19T09:39:54.076017Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:15:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"422"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"619301208a704c6a984ba41a276dfa38"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"suffix\": \".pdf\",\n \"created\": \"2024-06-04T05:31:35.654009Z\",\n \"modified\": \"2024-06-04T05:32:48.318755Z\",\n \"size\": 276750,\n \"content_size\": 50312,\n \"name\": \"Test Document 24\",\n \"doc_type\": \"file\",\n \"p_status\": \"Upsertion\",\n \"status\": \"Completed\",\n \"active\": false,\n \"etag\": null,\n \"category\": \"faqs\",\n \"ref\": null,\n \"project\": \"asasd564***jNO3B\"\n }\n ]\n}"}],"_postman_id":"0a70e5ae-b6fa-4b55-89c4-5a19aeba8033"},{"name":"Get One","id":"2925efd1-3c36-4bec-971f-e3a50596a24b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/document-files/{{doc_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","document-files","{{doc_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"d853ccfd-875b-46c0-8622-065f96f07ae4","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/document-files/{{doc_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:16:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"370"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"07e98cc678604dd49ca4a1079fe4fc19"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"suffix\": \".pdf\",\n \"created\": \"2024-06-04T05:31:35.654009Z\",\n \"modified\": \"2024-06-04T05:32:48.318755Z\",\n \"size\": 276750,\n \"content_size\": 50312,\n \"name\": \"Test Document 24\",\n \"doc_type\": \"file\",\n \"p_status\": \"Upsertion\",\n \"status\": \"Completed\",\n \"active\": false,\n \"etag\": null,\n \"category\": \"faqs\",\n \"ref\": null,\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"2925efd1-3c36-4bec-971f-e3a50596a24b"},{"name":"Delete One","id":"b0f3e91b-3455-4183-8f97-c8b539724656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://core.api.caleida.io/docs/v1/document-files/{{doc_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","document-files","{{doc_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"53f74e06-0abb-4238-99b4-fc90201d0cbe","name":"Delete One","originalRequest":{"method":"DELETE","header":[],"url":"https://core.api.caleida.io/docs/v1/document-files/{{doc_id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:17:46 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"27822d18fe044bb3ae7af7c9214e6ac5"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b0f3e91b-3455-4183-8f97-c8b539724656"},{"name":"Create","id":"16057f2d-6122-49c4-b2cf-c4c0a68f7907","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 2","type":"text"},{"key":"project","value":"{{project_id}}","type":"text"},{"key":"file","type":"file","src":"/C:/Users/souvik/Downloads/Employment_Agreement_Indefinite_India_Souvik_Dutta.pdf"},{"key":"category","value":"prod_n_serv","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/document-files/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","document-files",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"e2dd1ae5-bb8f-4c75-a973-24169c96dc4d","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 2","type":"text"},{"key":"project","value":"{{project_id}}","type":"text"},{"key":"file","type":"file","src":"/C:/Users/souvik/Downloads/Employment_Agreement_Indefinite_India_Souvik_Dutta.pdf"},{"key":"category","value":"prod_n_serv","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/document-files/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:16:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"371"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"aed5430db64b4e79bfb5aef338edd217"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"suffix\": \".pdf\",\n \"created\": \"2024-06-04T06:16:22.746268Z\",\n \"modified\": \"2024-06-04T06:16:23.270963Z\",\n \"size\": 276750,\n \"content_size\": null,\n \"name\": \"Test Document 2\",\n \"doc_type\": \"file\",\n \"p_status\": \"Pending\",\n \"status\": \"Pending\",\n \"active\": false,\n \"etag\": null,\n \"category\": \"prod_n_serv\",\n \"ref\": null,\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"16057f2d-6122-49c4-b2cf-c4c0a68f7907"},{"name":"Update","id":"296d239d-10b1-42df-8efd-1c7168593550","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 24","type":"text"},{"key":"category","value":"faqs","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/document-files/{{doc_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","document-files","{{doc_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"c9c2e23d-cedd-4f2f-8442-aad9e11809d8","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 24","type":"text"},{"key":"category","value":"faqs","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/document-files/{{doc_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:17:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"370"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"c1b78488738540ebbb482d6bef8a55ac"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"suffix\": \".pdf\",\n \"created\": \"2024-06-04T05:31:35.654009Z\",\n \"modified\": \"2024-06-04T06:17:33.883697Z\",\n \"size\": 276750,\n \"content_size\": 50312,\n \"name\": \"Test Document 24\",\n \"doc_type\": \"file\",\n \"p_status\": \"Upsertion\",\n \"status\": \"Completed\",\n \"active\": false,\n \"etag\": null,\n \"category\": \"faqs\",\n \"ref\": null,\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"296d239d-10b1-42df-8efd-1c7168593550"},{"name":"status","id":"de4ec0c1-83e2-4f5b-9b97-a45023af685c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/document-files/completion_status?project={{project_id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","document-files","completion_status"],"host":["core","api","caleida","io"],"query":[{"key":"project","value":"{{project_id}}"}],"variable":[]}},"response":[{"id":"2713d1ff-211b-4742-b014-3739faf58b10","name":"status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/docs/v1/document-files/completion_status","protocol":"https","host":["core","api","caleida","io"],"path":["docs","v1","document-files","completion_status"],"query":[{"key":"project","value":"f552a81a-0b6a-420c-a637-487681a70d45","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 31 Jan 2024 08:13:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"51"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"e6bb2482fe564c9598ac3d1fc3e4e530"}],"cookie":[],"responseTime":null,"body":"{\n \"docs_total\": 0,\n \"docs_completed\": 0,\n \"docs_failed\": 0\n}"},{"id":"3fc22a81-6114-41f5-bf14-4c9adefa8f7b","name":"with project","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/docs/v1/document-files/completion_status?project={{project_id}}","protocol":"https","host":["core","api","caleida","io"],"path":["docs","v1","document-files","completion_status"],"query":[{"key":"project","value":"{{project_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 31 Jan 2024 08:19:35 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"51"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"bd1ffef4b374463d81639877c3d5d58a"}],"cookie":[],"responseTime":null,"body":"{\n \"docs_total\": 0,\n \"docs_completed\": 0,\n \"docs_failed\": 0\n}"}],"_postman_id":"de4ec0c1-83e2-4f5b-9b97-a45023af685c"}],"id":"a1a64ec6-400f-4896-9038-a551bc7d9193","description":"

Document Management API 📄

Upload Document

Description: Allows users to upload various types of documents to the Caleida platform. Supported file types include PDFs, Word files, spreadsheets, and more. 📥📄

Get List of Documents

Description: Retrieves a list of all documents available within the Caleida platform. This list can be filtered based on various criteria. 📋📄

Delete Document

Description: Enables users to delete documents that are no longer needed from the Caleida platform. 🗑️📄

Get Document Status

Description: Retrieves the current status of a document within the Caleida platform. This includes information on processing, availability, and any errors encountered. 📊📄

Throttle Limit : DOCS

\n","_postman_id":"a1a64ec6-400f-4896-9038-a551bc7d9193","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Website","item":[{"name":"Webpages","item":[{"name":"Get List ( + filters )","id":"b62835be-ba12-4aa5-9cdf-aebda096317f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/webpage-files/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","webpage-files",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"{{project_id}}"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Extraction
Transformation
Pre Processing
Post Processing
Upsertion

\n","type":"text/plain"},"key":"p_status","value":"Upsertion"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Running
Completed
Failed

\n","type":"text/plain"},"key":"status","value":"Completed"},{"disabled":true,"key":"created__gte","value":"2023-12-19T09:39:54.076017Z"}],"variable":[]}},"response":[],"_postman_id":"b62835be-ba12-4aa5-9cdf-aebda096317f"},{"name":"Get One","id":"1e732312-c8ee-4889-9dfe-73586756bc75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/webpage-files/{{page_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","webpage-files","{{page_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e732312-c8ee-4889-9dfe-73586756bc75"},{"name":"Delete One","id":"c6fded7e-52cd-4b72-9b2d-bee40ab3255b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://core.api.caleida.io/docs/v1/webpage-files/{{page_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","webpage-files","{{page_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6fded7e-52cd-4b72-9b2d-bee40ab3255b"},{"name":"Update","id":"859e30f7-c1c2-46f1-94e3-46d8215ef22a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 24","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/webpage-files/{{page_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","webpage-files","{{page_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"859e30f7-c1c2-46f1-94e3-46d8215ef22a"}],"id":"d35a4b2f-b69c-4315-be14-82049ba5d172","_postman_id":"d35a4b2f-b69c-4315-be14-82049ba5d172","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Get List ( + filters )","id":"a7c8ba84-33f8-4cf4-90e3-5c28a2c80540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/websites/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","websites",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"0648ff7b-d7e7-4c90-b542-8c21e2549f1b"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Extraction
Transformation
Pre Processing
Post Processing
Upsertion

\n","type":"text/plain"},"key":"p_status","value":"Upsertion"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Running
Completed
Failed

\n","type":"text/plain"},"key":"status","value":"Completed"},{"disabled":true,"key":"created__gte","value":"2023-12-19T09:39:54.076017Z"}],"variable":[]}},"response":[{"id":"5a9c7f49-f004-4ede-84cf-0d877052c8d3","name":"Get List ( + filters )","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/docs/v1/websites/","protocol":"https","host":["core","api","caleida","io"],"path":["docs","v1","websites",""],"query":[{"key":"project","value":"asasd564***jNO3B","disabled":true},{"key":"p_status","value":"Upsertion","description":"Can be any one:\n1. Pending\n2. Extraction\n3. Transformation\n4. Pre Processing\n5. Post Processing\n6. Upsertion","disabled":true},{"key":"status","value":"Completed","description":"Can be any one:\n1. Pending\n2. Running\n3. Completed\n4. Failed","disabled":true},{"key":"created__gte","value":"2023-12-19T09:39:54.076017Z","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:17:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2284"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"9c25f0c5afc14d688011ca066a6c70ee"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 6,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-06-04T05:33:47.081873Z\",\n \"modified\": \"2024-06-04T05:33:53.697115Z\",\n \"name\": \"Test Document 2\",\n \"doc_type\": \"website\",\n \"p_status\": \"Extraction\",\n \"status\": \"Completed\",\n \"active\": false,\n \"etag\": null,\n \"root_url\": \"https://example.com\",\n \"md\": 500,\n \"size\": 1305,\n \"content_size\": 1305,\n \"project\": \"asasd564***jNO3B\"\n }\n \n ]\n}"}],"_postman_id":"a7c8ba84-33f8-4cf4-90e3-5c28a2c80540"},{"name":"Get One","id":"d33f7cad-4569-4f6f-8fe5-36068c2b7499","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/websites/{{website_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","websites","{{website_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"3c3f02a8-9c9b-41b8-bc8e-6e1702ce255e","name":"Get One","originalRequest":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/websites/{{website_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:18:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"367"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"8164ffb6a9d8475f80def907405fecda"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-06-04T05:33:47.081873Z\",\n \"modified\": \"2024-06-04T05:33:53.697115Z\",\n \"name\": \"Test Document 2\",\n \"doc_type\": \"website\",\n \"p_status\": \"Extraction\",\n \"status\": \"Completed\",\n \"active\": false,\n \"etag\": null,\n \"root_url\": \"https://example.com\",\n \"md\": 500,\n \"size\": 1305,\n \"content_size\": 1305,\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"d33f7cad-4569-4f6f-8fe5-36068c2b7499"},{"name":"Delete One","id":"9c165ff3-a310-48ef-bed1-6786b0c32aff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://core.api.caleida.io/docs/v1/websites/{{website_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","websites","{{website_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c165ff3-a310-48ef-bed1-6786b0c32aff"},{"name":"Create","id":"b6775bb1-1ee0-43de-82ac-5d876326f489","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 2","type":"text"},{"key":"project","value":"{{project_id}}","type":"text"},{"key":"root_url","value":"https://example.com","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/websites/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","websites",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"3ce6d5e3-4832-445c-868c-7484ff331de7","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 2","type":"text"},{"key":"project","value":"{{project_id}}","type":"text"},{"key":"root_url","value":"https://example.com","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/websites/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:18:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"362"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"070287eb9f994b23b6c858a431a2fd5f"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-06-04T06:18:25.717132Z\",\n \"modified\": \"2024-06-04T06:18:25.725900Z\",\n \"name\": \"Test Document 2\",\n \"doc_type\": \"website\",\n \"p_status\": \"Pending\",\n \"status\": \"Pending\",\n \"active\": false,\n \"etag\": null,\n \"root_url\": \"https://example.com\",\n \"md\": 500,\n \"size\": null,\n \"content_size\": null,\n \"project\":\"asasd564***jNO3B\"\n}"}],"_postman_id":"b6775bb1-1ee0-43de-82ac-5d876326f489"},{"name":"Update","id":"6153cbb4-5e5f-4bf2-a04d-81c3fe78df3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 24","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/websites/{{website_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","websites","{{website_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"2a2a8be5-5cc0-4a12-af56-f0d828782fa5","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Document 24","type":"text"}]},"url":"https://core.api.caleida.io/docs/v1/websites/{{website_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 04 Jun 2024 06:18:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"368"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; font-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; script-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; style-src 'self' 'unsafe-inline' https://fra1.digitaloceanspaces.com/; worker-src 'self' 'unsafe-inline' blob: https://fra1.digitaloceanspaces.com/; img-src 'self' 'unsafe-inline' data: https://fra1.digitaloceanspaces.com/"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"870524597eae4a948255988a3f46f2f8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asasd564***jNO3B\",\n \"created\": \"2024-06-04T05:33:47.081873Z\",\n \"modified\": \"2024-06-04T06:18:37.757059Z\",\n \"name\": \"Test Document 24\",\n \"doc_type\": \"website\",\n \"p_status\": \"Extraction\",\n \"status\": \"Completed\",\n \"active\": false,\n \"etag\": null,\n \"root_url\": \"https://example.com\",\n \"md\": 500,\n \"size\": 1305,\n \"content_size\": 1305,\n \"project\": \"asasd564***jNO3B\"\n}"}],"_postman_id":"6153cbb4-5e5f-4bf2-a04d-81c3fe78df3a"},{"name":"status","id":"0a0d0076-2215-426e-9e0c-ff55890c146b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/websites/completion_status?project={{project_id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","websites","completion_status"],"host":["core","api","caleida","io"],"query":[{"key":"project","value":"{{project_id}}"}],"variable":[]}},"response":[{"id":"6d5244f0-22f3-4d50-a5cf-113a0255d475","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/docs/v1/websites/completion_status","protocol":"https","host":["core","api","caleida","io"],"path":["docs","v1","websites","completion_status"],"query":[{"key":"project","value":"f552a81a-0b6a-420c-a637-487681a70d45","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 31 Jan 2024 08:18:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"67"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"fc9b284afe7f4ff19c0b9741f95d2f51"}],"cookie":[],"responseTime":null,"body":"{\n \"webpages_total\": 150,\n \"webpages_completed\": 150,\n \"webpages_failed\": 0\n}"},{"id":"3ecfb1de-fe9c-4265-8e1a-715c0ea58692","name":"with project filter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://core.api.caleida.io/docs/v1/websites/completion_status?project={{project_id}}","protocol":"https","host":["core","api","caleida","io"],"path":["docs","v1","websites","completion_status"],"query":[{"key":"project","value":"{{project_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 31 Jan 2024 08:19:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-Request-ID","value":"1d04d1cea63f496fafbe3ff4053c9bd0"}],"cookie":[],"responseTime":null,"body":"{\n \"webpages_total\": 0,\n \"webpages_completed\": 0,\n \"webpages_failed\": 0\n}"}],"_postman_id":"0a0d0076-2215-426e-9e0c-ff55890c146b"}],"id":"eeb305d0-e833-4182-93d9-9c2de867433f","description":"

Website Management API 🌐

Add Website

Description: Allows users to add websites to the Caleida platform. This includes fetching and integrating content from specified URLs.
\n
Features: Supports automatic content updates, ensuring that the information remains current and accurate. 🖥️🌐
\n

Get List of Websites

Description: Retrieves a list of all websites added to the Caleida platform. This list can be filtered based on various criteria.
\n
Features: Provides an overview of websites, including metadata such as URLs, descriptions, and last update dates. 📋🌐
\n

Delete Website

Description: Enables users to delete websites that are no longer needed from the Caleida platform.
\n
Features: Includes options for soft deletion (archiving) or permanent deletion, with appropriate permissions and confirmations to prevent accidental loss of important data. 🗑️🌐
\n

Get Website Status

Description: Retrieves the current status of a website within the Caleida platform. This includes information on processing, availability, and any errors encountered.
\n
Features: Provides real-time status updates to ensure users are informed about the website's current state. 📊🌐
\n

Throttle Limit : DOCS

\n","_postman_id":"eeb305d0-e833-4182-93d9-9c2de867433f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"RSS Feed","item":[{"name":"Get List ( + filters )","id":"3b930af7-ecdb-442d-8316-3cff3a1a3583","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/docs/v1/rss_feed/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["docs","v1","rss_feed",""],"host":["core","api","caleida","io"],"query":[{"disabled":true,"key":"project","value":"0648ff7b-d7e7-4c90-b542-8c21e2549f1b"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Extraction
Transformation
Pre Processing
Post Processing
Upsertion

\n","type":"text/plain"},"key":"p_status","value":"Upsertion"},{"disabled":true,"description":{"content":"

Can be any one:

Pending
Running
Completed
Failed

RSS Feed Management API 📰

Add RSS Feed

Description: Allows users to add RSS feeds to the Caleida platform. This enables the platform to fetch and integrate content from specified RSS URLs.
\n
Features: Supports scheduled updates, ensuring that the latest feed content is regularly fetched and available for use. 🔄📰
\n

Get List of RSS Feeds

Description: Retrieves a list of all RSS feeds added to the Caleida platform. This list can be filtered based on various criteria.
\n
Features: Provides an overview of RSS feeds, including metadata such as feed URLs, descriptions, and update schedules. 📋📰
\n

Delete RSS Feed

Description: Enables users to delete RSS feeds that are no longer needed from the Caleida platform.
\n
Features: Includes options for soft deletion (archiving) or permanent deletion, with appropriate permissions and confirmations to prevent accidental loss of important data. 🗑️📰
\n

Get RSS Feed Status

Description: Retrieves the current status of an RSS feed within the Caleida platform. This includes information on processing, update frequency, and any errors encountered.
\n
Features: Provides real-time status updates to ensure users are informed about the RSS feed's current state and reliability. 📊📰
\n

Throttle Limit : DOCS

\n","_postman_id":"3b66821f-8618-47be-a20a-9556c8dde9aa","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"id":"3e1f90d8-64e4-43e4-ad00-8312a4fefa8e","description":"

Document Management 📄

Create Documents

Functionality: Allows users to create new documents within the Caleida platform. Users can start with a blank document or use predefined templates to ensure consistency and structure.
\n
Features: Supports rich text formatting, embedding multimedia content, and adding hyperlinks to external resources. 🖋️📝
\n

Edit Documents

Functionality: Provides tools for editing existing documents. Users can update content, adjust formatting, and make other modifications to keep the documents current and relevant.
\n
Features: Real-time collaboration capabilities allow multiple users to work on the same document simultaneously, with version control to track changes and revisions. 🔄📄
\n

Delete Documents

Functionality: Enables users to delete documents that are no longer needed. This helps maintain an organized and clutter-free document repository.
\n
Features: Includes options for soft deletion (archiving) or permanent deletion, with appropriate permissions and confirmations to prevent accidental loss of important data. 🗑️🚫
\n

Upload Documents

Functionality: Allows users to upload various types of documents, such as PDFs, Word files, and spreadsheets, into the Caleida platform. 📥📄

Add Websites

Functionality: Enables the inclusion of website content in the document repository. Users can add URLs to relevant web pages or articles. 🌐📄

RSS Feeds

Functionality: Supports the integration of RSS feeds into the document management system. Users can subscribe to feeds from various sources to receive regular updates. 📰🔄

Knowledge Base Integration

All documents, websites, and RSS feeds managed within the Caleida platform contribute to the agent's knowledge base. This comprehensive repository of information empowers the agent to provide accurate and up-to-date responses, enhancing its effectiveness and reliability. 🧠💡

By leveraging these document management features, users can ensure that their knowledge base remains robust, well-organized, and easily accessible, facilitating better decision-making and efficient information dissemination. 🌟

Throttle Limit : DOCS

\n","_postman_id":"3e1f90d8-64e4-43e4-ad00-8312a4fefa8e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Campaign","item":[{"name":"Users","item":[{"name":"List","id":"ce6de96f-c0db-47ad-b67a-cf5976d40e3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/","description":"

List all of your campaign users

Get a single campaign user

This is route used for testing the campaign if the set up is correct the test user should receive a text from the agent

This route is used to generate the initial message for email campaign users. If you need to regenerate the initial message, you can do so by setting the 'force' parameter to 'true'. This will overwrite the existing message with a new one.

this route user for updating the campaign user

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns","v1","{{campaign_id}}","users","{{campaign_contact_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"f855685e-795b-4f9e-b299-5941bd7121ea","name":"Update","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"for_test\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/{{campaign_contact_id}}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"68209130-*******-65841ae0dc38\",\r\n \"created\": \"2024-06-13T06:34:33.559736Z\",\r\n \"modified\": \"2024-06-13T11:52:56.373179Z\",\r\n \"for_test\": true,\r\n \"name\": \"****\",\r\n \"email\": \"68209130-*******-65841ae0dc38\",\r\n \"phone\": \"68209130-*******-65841ae0dc38\",\r\n \"notes\": \"Hello world\",\r\n \"agent_notes\": \"User initiated conversation with a greeting on 13 June 2024 at 07:19 UTC.\\nUser greeted again on 13 June 2024 at 08:20 UTC.\\nUser inquired about available options on 13 June 2024 at 08:21 UTC.\\nUser greeted again and inquired about available options on 13 June 2024 at 08:23 UTC.\\nUser inquired about available options and performed a simple math query on 13 June 2024 at 08:24 UTC.\\nUser greeted and performed simple math queries on 13 June 2024 at 08:24 UTC.\\nUser greeted and performed a simple math query on 13 June 2024 at 08:29 UTC.\\nUser greeted again on 13 June 2024 at 08:39 UTC.\\nUser greeted and asked a simple math query on 13 June 2024 at 08:40 UTC.\\nUser acknowledged the welcome message on 13 June 2024 at 09:12 UTC.\\nUser acknowledged the welcome message and responded with \\\"ad\\\" on 13 June 2024 at 09:20 UTC.\\nUser greeted again on 13 June 2024 at 11:52 UTC.\",\r\n \"follow_up\": \"2024-06-13T12:30:00Z\",\r\n \"follow_up_msg\": \"Hey, you were busy when we last talked, is this a good time to continue our conversation?\",\r\n \"first_resp\": true,\r\n \"wfur\": false,\r\n \"tries\": 0,\r\n \"amc\": 93,\r\n \"finished\": false,\r\n \"finished_reason\": \"Error: {\\\"status_code\\\":10422,\\\"message\\\":\\\"[{'type': 'missing', 'loc': ('header', 'service-key'), 'msg': 'Field required', 'input': None, 'url': 'https://errors.pydantic.dev/2.6/v/missing'}]\\\",\\\"data\\\":null}\",\r\n \"finished_at\": \"2024-06-13T06:34:33.560165Z\",\r\n \"goal_ach\": false,\r\n \"goal_ind\": \"The user has not received the correct answer to their query yet.\",\r\n \"uid\": null,\r\n \"meta_info\": {},\r\n \"campaign\": \"68209130-*******-65841ae0dc38\",\r\n \"chat\": \"68209130-*******-65841ae0dc38\"\r\n}"}],"_postman_id":"cf49748c-079c-4656-8b4a-c9dba06fef01"},{"name":"Create","id":"5aa1992c-2686-4e76-9c03-2fa777693aac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Raj S.\",\n \"email\": \"rs4@gmail.com\",\n \"phone\": \"********\",\n \"notes\": \"\",\n \"meta_info\": {\n \"intrest\": \"toyota fortner\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns","v1","{{campaign_id}}","users",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"ec0d38e5-7364-4e8c-8cbb-8d207f32f083","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Raj S.\",\n \"email\": \"rs4@gmail.com\",\n \"phone\": \"********\",\n \"notes\": \"\",\n \"meta_info\": {\n \"intrest\": \"toyota fortner\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"68209130-*******-65841ae0dc38\",\n \"created\": \"2024-06-13T06:34:33.559736Z\",\n \"modified\": \"2024-06-13T11:52:56.373179Z\",\n \"for_test\": true,\n \"name\": \"****\",\n \"email\": \"68209130-*******-65841ae0dc38\",\n \"phone\": \"68209130-*******-65841ae0dc38\",\n \"notes\": \"Hello world\",\n \"agent_notes\": \"User initiated conversation with a greeting on 13 June 2024 at 07:19 UTC.\\nUser greeted again on 13 June 2024 at 08:20 UTC.\\nUser inquired about available options on 13 June 2024 at 08:21 UTC.\\nUser greeted again and inquired about available options on 13 June 2024 at 08:23 UTC.\\nUser inquired about available options and performed a simple math query on 13 June 2024 at 08:24 UTC.\\nUser greeted and performed simple math queries on 13 June 2024 at 08:24 UTC.\\nUser greeted and performed a simple math query on 13 June 2024 at 08:29 UTC.\\nUser greeted again on 13 June 2024 at 08:39 UTC.\\nUser greeted and asked a simple math query on 13 June 2024 at 08:40 UTC.\\nUser acknowledged the welcome message on 13 June 2024 at 09:12 UTC.\\nUser acknowledged the welcome message and responded with \\\"ad\\\" on 13 June 2024 at 09:20 UTC.\\nUser greeted again on 13 June 2024 at 11:52 UTC.\",\n \"follow_up\": \"2024-06-13T12:30:00Z\",\n \"follow_up_msg\": \"Hey, you were busy when we last talked, is this a good time to continue our conversation?\",\n \"first_resp\": true,\n \"wfur\": false,\n \"tries\": 0,\n \"amc\": 93,\n \"finished\": false,\n \"finished_reason\": \"Error: {\\\"status_code\\\":10422,\\\"message\\\":\\\"[{'type': 'missing', 'loc': ('header', 'service-key'), 'msg': 'Field required', 'input': None, 'url': 'https://errors.pydantic.dev/2.6/v/missing'}]\\\",\\\"data\\\":null}\",\n \"finished_at\": \"2024-06-13T06:34:33.560165Z\",\n \"goal_ach\": false,\n \"goal_ind\": \"The user has not received the correct answer to their query yet.\",\n \"uid\": null,\n \"meta_info\": {},\n \"campaign\": \"68209130-*******-65841ae0dc38\",\n \"chat\": \"68209130-*******-65841ae0dc38\"\n}"}],"_postman_id":"5aa1992c-2686-4e76-9c03-2fa777693aac"},{"name":"Add Next","id":"96a22121-8823-416b-b3bf-125a1a8f35f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Raj S.\",\n \"email\": \"r***\",\n \"phone\": \"****\",\n \"notes\": \"\",\n \"meta_info\": {\n \"intrest\": \"toyota fortner\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/add_next/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns","v1","{{campaign_id}}","users","add_next",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[{"id":"b8627976-a9c4-4fc5-9193-24ab1cd34ac6","name":"Add Next","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Raj S.\",\n \"email\": \"r***\",\n \"phone\": \"****\",\n \"notes\": \"\",\n \"meta_info\": {\n \"intrest\": \"toyota fortner\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/add_next/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"68209130-*******-65841ae0dc38\",\n \"created\": \"2024-06-13T06:34:33.559736Z\",\n \"modified\": \"2024-06-13T11:52:56.373179Z\",\n \"for_test\": true,\n \"name\": \"****\",\n \"email\": \"68209130-*******-65841ae0dc38\",\n \"phone\": \"68209130-*******-65841ae0dc38\",\n \"notes\": \"Hello world\",\n \"agent_notes\": \"User initiated conversation with a greeting on 13 June 2024 at 07:19 UTC.\\nUser greeted again on 13 June 2024 at 08:20 UTC.\\nUser inquired about available options on 13 June 2024 at 08:21 UTC.\\nUser greeted again and inquired about available options on 13 June 2024 at 08:23 UTC.\\nUser inquired about available options and performed a simple math query on 13 June 2024 at 08:24 UTC.\\nUser greeted and performed simple math queries on 13 June 2024 at 08:24 UTC.\\nUser greeted and performed a simple math query on 13 June 2024 at 08:29 UTC.\\nUser greeted again on 13 June 2024 at 08:39 UTC.\\nUser greeted and asked a simple math query on 13 June 2024 at 08:40 UTC.\\nUser acknowledged the welcome message on 13 June 2024 at 09:12 UTC.\\nUser acknowledged the welcome message and responded with \\\"ad\\\" on 13 June 2024 at 09:20 UTC.\\nUser greeted again on 13 June 2024 at 11:52 UTC.\",\n \"follow_up\": \"2024-06-13T12:30:00Z\",\n \"follow_up_msg\": \"Hey, you were busy when we last talked, is this a good time to continue our conversation?\",\n \"first_resp\": true,\n \"wfur\": false,\n \"tries\": 0,\n \"amc\": 93,\n \"finished\": false,\n \"finished_reason\": \"Error: {\\\"status_code\\\":10422,\\\"message\\\":\\\"[{'type': 'missing', 'loc': ('header', 'service-key'), 'msg': 'Field required', 'input': None, 'url': 'https://errors.pydantic.dev/2.6/v/missing'}]\\\",\\\"data\\\":null}\",\n \"finished_at\": \"2024-06-13T06:34:33.560165Z\",\n \"goal_ach\": false,\n \"goal_ind\": \"The user has not received the correct answer to their query yet.\",\n \"uid\": null,\n \"meta_info\": {},\n \"campaign\": \"68209130-*******-65841ae0dc38\",\n \"chat\": \"68209130-*******-65841ae0dc38\"\n}"}],"_postman_id":"96a22121-8823-416b-b3bf-125a1a8f35f5"},{"name":"Delete","id":"5a10486f-1325-4a39-9536-d27c52aa4ddc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/{{campaign_contact_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}},"urlObject":{"protocol":"https","path":["campaigns","v1","{{campaign_id}}","users","{{campaign_contact_id}}",""],"host":["core","api","caleida","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a10486f-1325-4a39-9536-d27c52aa4ddc"},{"name":"Upload CSV","id":"d21e3967-ad34-4c5a-b1a4-61973aa3de8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/C:/Users/souvik/Downloads/data (18) (1).csv"}]},"url":"https://core.api.caleida.io/campaigns/v1/{{campaign_id}}/users/upload_users/","description":"

This route is used for importing users to the campaign as a CSV file

Campaign User Management and Testing 🚀

Create Campaign

Allows users to create new campaigns by defining parameters such as campaign name, target audience, messaging content, scheduling, and other relevant details. 🎯✉️

Edit Campaign

Enables users to modify existing campaigns, updating details such as messaging content, scheduling, target audience, and other parameters to adapt to changing requirements. 🔄📈

Delete Campaign

Permits users to permanently remove a campaign from the Caleida platform. This action deletes the campaign and its associated configurations. 🗑️🚫

Manage Campaign Users

Provides administrators the ability to manage users associated with campaigns, including adding, removing, or updating user permissions and access levels. 👥🔧

Test Campaign

Allows users to test campaigns before full deployment. This feature enables testing of messaging content, scheduling, and other campaign parameters to ensure accuracy and effectiveness. 🎯🛠️

This comprehensive overview covers the lifecycle management of campaigns and associated user roles within the Caleida platform.

\n","_postman_id":"1969d317-c174-4a98-9032-0bb8dc1fb138","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}},{"name":"Create","id":"6e92eb57-e159-4936-8672-8ed45c695d2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Campaign\",\n \"language\": \"en\",\n \"project\": \"6ca6e140-f01f-4210-a2e5-3c6c4b9bb67b\",\n \"channel_config\": {\n \"template_name\": \"some_template\",\n \"language\": \"en\",\n \"placeholders\": [\n \"toyota\",\n \"{intrest}\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.api.caleida.io/campaigns/v1/?project={{project_id}}","description":"

This route is used for creating a campaign

This route is used for listing a campaign

This route is used for getting one campaign

This route is used for updating the campaign

This route is used for canceling the campaign

This route is used for activating the campaign

This route is used for checking the status of the campaign

Campaign Management 📊

Create Campaign

Description: Allows users to create new campaigns by defining parameters such as campaign name, target audience demographics, messaging content, scheduling, and other relevant details.
\n
Features: Campaigns can be tailored to reach specific target audiences, which can be segmented based on user attributes imported via CSV files or manually added within the platform. 🎯✉️
\n

Delete Campaign

Description: Enables users to permanently remove a campaign from the Caleida platform. This action deletes the campaign and its associated configurations, ensuring no residual data remains.
\n
Features: Provides a streamlined process to clean up outdated or completed campaigns, maintaining platform efficiency and data integrity. 🗑️🚫
\n

Edit Campaign

Description: Allows users to modify existing campaigns, adapting details such as messaging content, scheduling, target audience demographics, and other parameters to meet evolving marketing or communication strategies.
\n
Features: Facilitates agility in campaign management, enabling adjustments based on real-time analytics or changing business requirements to optimize campaign performance. 🔄📈
\n

Campaign Usage

Description: Campaigns can leverage user data imported via CSV files or manually added within the platform, ensuring targeted messaging and efficient communication strategies tailored to specific audience segments.
\n
Features: Enhances engagement and effectiveness by delivering personalized content and optimizing campaign reach. 🎯📈
\n

\n","_postman_id":"9ed99b2a-afa1-46b9-9e08-c064a18aa042","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e34b726a-9403-485c-b370-5609b51a10b5","id":"e34b726a-9403-485c-b370-5609b51a10b5","name":"Caleida Public Api","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{API-KEY}}"}]}},"event":[{"listen":"prerequest","script":{"id":"ddc4db24-5704-4764-be7a-f7d9250bce25","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2198523f-d74f-45d2-b2e1-3142b996927b","type":"text/javascript","exec":[""]}}]}