๐ Welcome to the Account Level API Workspace!
\nThis workspace is your go-to hub for exploring, demonstrating, and sharing our powerful APIs. Whether you're getting started or showcasing capabilities to customers, you'll find everything you need here.
\nInside this workspace, you'll discover two curated types of Postman collections designed to simplify API consumption and demonstrate their value:
\nReference Collections
\nThese collections provide a comprehensive overview of each API, including requests and detailed documentation.
\nShare these with customers to give them a thorough understanding of our APIs and how they can be effectively used.
\nBlueprint and Workflow Collections
\nThese collections showcase real-world use cases, illustrating how our APIs can be seamlessly integrated into various workflows.
\nPerfect for demonstrating the practical power of our APIs to consumers.
\nYour API key is generated and provided as part of the response when you create an account. Be sure to securely store and manage it for authentication purposes.
\nIf you have any questions, feedback, or need assistance, donโt hesitate to reach out to your manager. We're here to support you!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31006596","collectionId":"09abd60f-a345-49f5-a26a-5a2d0d8fb78c","publishedId":"2sAXqp9j5u","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-16T14:39:10.000Z"},"item":[{"name":"Tasks","item":[{"name":"Category","item":[{"name":"Get Task Categories","id":"c1c60714-a41f-46c1-a0da-9bde1bdebc2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apiKey","value":"Bearer 0000000-000000-000000","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.trustbrand.ai/api/tasks/category?page=1&limit=10","description":"The endpoint retrieves a list of Tasks Categories.
\nThe response of this request can be documented as a JSON schema:
\nLimit Parameter Description:
The limit parameter specifies the number of records to fetch per API response. The value must be between 10 and 100.
Minimum value: 10
\nMaximum value: 100
\nPage Parameter Description:
\nThe page parameter specifies which page of records to retrieve when paginating through results. It is used in combination with the limit parameter to fetch specific subsets of data.
Default value: 1
Minimum value: 1
If a value outside this range is provided, the API will return an error
\n{\n \"success\": true,\n \"message\": \"Categories found successfully\",\n \"totalPages\": 1,\n \"totalRecords\": 1,\n \"currentPage\": 1,\n \"limit\": 10,\n \"data\": [\n {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"name\": \"Your AI\",\n \"createdAt\": \"2024-12-09T10:00:25.573Z\",\n \"updatedAt\": \"2024-12-09T10:00:25.573Z\"\n }\n ]\n}\n\nIt's required
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"AI Guru\",\r\n \"user_id\":\"a3f79b12d6c48e5f08ab34de\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.trustbrand.ai/api/tasks/category","description":"This endpoint allows you to create a new Task Category by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type with the following parameters:
\nname: (string) The name of the Task Category. (required)*
user_id: (string) A _id of the User. (required)*
Upon successful creation, the response will include the details of the newly created prompt category.
\n{\n \"success\": true,\n \"message\": \"Task Category successfully created\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"name\": \"AI Guru\",\n \"createdAt\": \"2024-12-18T15:44:10.636Z\",\n \"updatedAt\": \"2024-12-18T15:44:10.636Z\"\n }\n}\n\nThis endpoint allows you to update a Task Category by sending an HTTP PUT request to the specified URL. The request should include a JSON payload in the raw request body type with the following parameters:
\n_id: (string) The Id of the Task Category. (required)*
name: (string) The name of the Task Category. (optional)
Upon successful creation, the response will include the details of the newly created prompt category.
\n{\n \"success\": true,\n \"message\": \"Task Category successfully updated\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"name\": \"AI Guru Pro\",\n \"createdAt\": \"2024-12-18T15:44:10.636Z\",\n \"updatedAt\": \"2024-12-18T15:44:10.636Z\"\n }\n}\n\nIt's required.
\n","type":"text"}],"url":"https://api.trustbrand.ai/api/tasks/category/delete?_id=a3f79b12d6c48e5f08ab34de","description":"The API endpoint allows you to delete by sending an HTTP DELETE request to the specified URL. This is the query parameter we need
\n{\n \"success\": true,\n \"message\": \"Task Category successfully deleted\"\n}\n\nThe API endpoint allows you to create Task by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type, with the following parameters:
\ntitle (string): The title of the prompt (required)*
\ntasks_value (string): The content of the prompt (required)*
\ncategory (string): The ID of the category for the prompt (optional)
\nset_as (string): Indicates whether the prompt is set as \"personal\" or \"shared\" (required)*
\nuser_id (string): The ID of the user creating the prompt (required)*
\nUpon successful execution, the response will be in the form of a JSON schema, documenting the structure of the response data.
\n{\n \"success\": true,\n \"message\": \"Tasks successfully created\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"title\": \"Purpose-Driven Brand Messaging โ Expert Review\",\n \"task_value\": \"The prompt content that will use to prompt the AI.\",\n \"createdAt\": \"2024-12-20T13:29:10.010Z\",\n \"updatedAt\": \"2024-12-20T13:29:10.010Z\"\n }\n}\n\nThe API endpoint allows you to Generate Task by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type, with the following parameters:
\nusername (string): The username of the user (required)*
\ntask_query (string): The content for which you wnat to genrate task (required)*
\nassistant_id (string): The assistant_id of the assistant (required)*
\nUpon successful execution, the response will be in the form of a JSON schema, documenting the structure of the response data.
\n{\n \"success\": true,\n \"message\": \"Task generated\",\n \"data\": {\n \"title\": \"AI Content for Engaging Digital Promotions and Sustainability\",\n \"content\": \"**Objective/Goal:**\\nDevelop AI-generated content that effectively enhances and communicates the brand's position as a leader in digital promotions and gamification, aiming to boost customer engagement and brand loyalty through storytelling and innovation.\\n\\n**Context/Background:**\\nThe brand prides itself on being \\\"the O.G. of digital promotions & gamification\\\" with over 25 years of experience. It showcases a remarkable ability to create engaging, behavior-changing digital experiences. Notable achievements include a 500% increase in the customer database within eight months and a 48% rise in engaged loyalty members, all through innovative gamification strategies.\\n\\n**Specific Requirements:**\\n- Include specific examples of successful campaigns, such as interactive games and AR experiences, to illustrate the brand's capabilities.\\n- Highlight real-life success stories of contest winners to add emotional and social resonance.\\n- Align created content with themes of sustainability and community values, showcasing the brand's commitment to eco-friendly initiatives.\\n\\n**Intended Use:**\\nThe content will be used in marketing materials aimed at potential clients and partners interested in cutting-edge digital promotional strategies that emphasize customer engagement and environmental responsibility.\\n\\n**Tone and Style:**\\nMaintain a professional and innovative tone that reflects the brand's passion for creativity and technology, infused with a narrative style that resonates emotionally with audiences.\"\n }\n}\n\nLimit Parameter Description:
The limit parameter specifies the number of records to fetch per API response. The value must be between 10 and 100.
Minimum value: 10
\nMaximum value: 100
\nPage Parameter Description:
\nThe page parameter specifies which page of records to retrieve when paginating through results. It is used in combination with the limit parameter to fetch specific subsets of data.
Default value: 1
Minimum value: 1
{\n \"success\": true,\n \"message\": \"Tasks found successfully\",\n \"data\": [\n {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"title\": \"Test Update\",\n \"task_value\": \"Test Value\",\n \"createdAt\": \"2024-07-03T08:56:32.733Z\",\n \"updatedAt\": \"2024-11-28T16:47:37.645Z\"\n },\n ],\n \"totalPages\": 1,\n \"totalRecords\": 1,\n \"currentPage\": 1,\n \"limit\": 10,\n}\n\nThe API endpoint allows you to Generate Task by sending an GET request to the specified URL. The request should include query parameter:
\nIf you don't send _id in query you will get all the tasks
\n{\n \"success\": true,\n \"message\": \"Task found successfully\",\n \"data\": [\n {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"title\": \"Test Update\",\n \"task_value\": \"Test Value\",\n \"createdAt\": \"2024-07-03T08:56:32.733Z\",\n \"updatedAt\": \"2024-11-28T16:47:37.645Z\"\n },\n ]\n}\n\nThis endpoint is used to update a Task by sending an HTTP PUT request to the specified URL.
\n_id (string): The ID of the prompt to be updated. (required)*
title (string): The title of the prompt. (optional)
task_value (string): The content of the prompt. (optional)
category (string): The category of the prompt. (optional)
Upon a successful update, the response will contain the updated prompt details.
\n{\n \"success\": true,\n \"message\": \"Prompt updated successfully\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"title\": \"test123\",\n \"task_value\": \"The prompt content that will use to prompt the AI.\",\n \"createdAt\": \"2024-12-19T13:08:48.459Z\",\n \"updatedAt\": \"2024-12-19T13:10:49.154Z\"\n }\n}\n\nThe API endpoint allows you to delete by sending an HTTP DELETE request to the specified URL. This is the query parameter we need
\n{\n \"success\": true,\n \"message\": \"Tasks successfully deleted\"\n}\n\nThe API endpoint allows you to Create Conversations by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type, with the following parameters:
\nuserId (string): The _id of the user (required)*
\nassistant_id (string): The assistant_id of the assistant (required)*
\nEndFragment
\n{\n \"success\": true,\n \"message\": \"Chat found successfully\",\n \"data\": {\n \"conversation_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"username\": \"John Wick\"\n }\n}\n\nThe API endpoint allows you to Create Conversations by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type, with the following parameters:
\nuserId (string): The _id of the user (required)*
\nassistant_id (string): The assistant_id of the assistant (required)*
\nEndFragment
\n{\n \"success\": true,\n \"message\": \"chat found successfully\",\n \"data\": {\n \"conversation_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"username\": \"John Wick\"\n }\n}\n\nThe API endpoint allows you to Create a Chat by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type, with the following parameters:
\ntask (string): The content of the chat (required)*
\nconversation_id (string): We are getting this in the response on Create Conversations API (required)*
\nuserId (string): The _id of the user (required)*
\nassistant_id (string): The assistant_id of the assistant (required)*
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Message fetched successfully\",\n \"data\": {\n \"data\": \"AI, or Artificial Intelligence, refers to the simulation of human intelligence processes by machines, especially computer systems. These processes include learning (the acquisition of information and rules for using the information), reasoning (using rules to reach approximate or definite conclusions), and self-correction. AI is used in various applications, including expert systems, natural language processing, speech recognition, and machine vision. AI technologies are designed to perform tasks that typically require human intelligence, such as visual perception, speech recognition, decision-making, and language translation.\"\n }\n}\n\nThe API endpoint allows you to Add to Favourite by sending an HTTP POST request to the specified URL. The request should include a JSON payload in the raw request body type, the following Query Params:
\nchat_id (string): The _id of the chat (required)*
\nuser_id (string): The _id of the user (required)*
\ntask_id (string): The _id of the task (required)*
\nStartFragmentAdds a specific chat or conversation to the user's list of favourites, making it easier to access and prioritize important interactions.
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Favourite added successfully\"\n}\n\nThe API endpoint allows you to delete by sending an HTTP DELETE request to the specified URL. This is the query parameter we need
\nResponse:
\n{\n \"success\": true,\n \"message\": \"chat deleted found successfully\"\n}\n\nLimit Parameter Description:
The limit parameter specifies the number of records to fetch per API response. The value must be between 10 and 100.
Minimum value: 10
\nMaximum value: 100
\nPage Parameter Description:
\nThe page parameter specifies which page of records to retrieve when paginating through results. It is used in combination with the limit parameter to fetch specific subsets of data.
Default value: 1
Minimum value: 1
If a value outside this range is provided, the API will return an error
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Assistants records found\",\n \"totalPages\": 1,\n \"totalRecords\": 5,\n \"currentPage\": 1,\n \"limit\": 10,\n \"data\": [\n {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"assistant_id\": \"asst_u390OGuAFz1PxMfWo8HHEKgF\",\n \"assistant_name\": \"Your AI Assistant\",\n \"purpose\": \"Assistant instructions and purpose\",\n \"content_creativity\": \"0.7\",\n \"btgen\": \"0.8\",\n \"createdAt\": \"2024-11-14T13:56:49.547Z\",\n \"updatedAt\": \"2024-12-12T16:45:27.143Z\"\n },\n]\n}\n\nThe API endpoint allows you to Get All Chats by sending an HTTP GET request to the specified URL. There is an optional query params if you add that you will get Chats which create with the same conversation_id.
\nLimit Parameter Description:
The limit parameter specifies the number of records to fetch per API response. The value must be between 10 and 100.
Minimum value: 10
\nMaximum value: 100
\nPage Parameter Description:
\nThe page parameter specifies which page of records to retrieve when paginating through results. It is used in combination with the limit parameter to fetch specific subsets of data.
Default value: 1
Minimum value: 1
If a value outside this range is provided, the API will return an error
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Chats data retrieved successfully\",\n \"totalPages\": 1,\n \"totalRecords\": 1,\n \"currentPage\": 1,\n \"limit\": 10,\n \"data\": [\n {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"name\": \"example text\",\n \"username\": \"zain butt\",\n \"createdAt\": \"2024-09-10T09:42:55.043Z\",\n \"updatedAt\": \"2024-09-10T09:42:57.302Z\"\n },\n]\n}\n\nThe API endpoint allows you to Create Post by sending an HTTP POST request to the specified URL.
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Event found successfully\",\n \"data\": \"๐ Celebrate the spirit of sport and our cherished heritage on National Sporting Heritage Day! ๐
โจ Let's honour the perseverance, dedication, and passion that have defined our sporting legacy and continue to inspire future generations. Whether you're a player, a fan, or a supporter, today is a day to reflect on the moments that have brought us together and driven us forward. Share your favourite sporting memories with us โ let's keep the legacy alive! ๐ธ๐ดโโ๏ธโฝ๐\\n\\n#SportingHeritage #LegacyInMotion #ChampionMindset #SportsForAll โค๏ธ\\n\\nJoin us in this celebration and ensure our sporting history continues to thrive for years to come. ๐๐๐ช\\n\\n๐ฅ Donโt miss out! Visit our link in bio to discover more about our community initiatives and become a part of our story. Together, let's make a lasting impact! ๐ฏ\\n\\n#NationalSportingHeritageDay #InspireTheFuture #PassionAndPride #CommunitySpirit\\n\\n๐ Thank you for being a vital part of this journey. Here's to more incredible achievements and unforgettable moments. Cheers to the game-changers! ๐ฅ๐โจ\"\n}\n\nThe API endpoint allows you to Generate Image by sending an HTTP POST request to the specified URL.
\nResponse:
\n{\n \"data\": {\n \"revised_prompt\": \"Create an image for National Sporting Heritage Day in a digital futuristic style. The main scene is a grand sports stadium adorned with a collage representing numerous sports. Depict a variety of athletes with different descents and genders, actively engaged in sports like football, basketball, tennis, and swimming. The athletes' actions should reflect the intensity and passion of the sports they are participating in. In the background, picture a jubilant crowd who are there to support the competitors. At the center, display a golden medal with 'National Sporting Heritage Day' inscribed on it. The style should be remarkably vivid with striking, vibrant colors.\",\n \"url\": \"https://statictemp.maybetech.com/images/ai-generated/UePEUSJOt.png\"\n },\n \"success\": true,\n \"message\": \"Event found successfully\"\n}\n\nResponse:
\n{\n \"success\": true,\n \"message\": \"Fetch successfully\",\n \"data\": {\n \"data\": \"This is add memory test data\\n\\nHello! How can I assist you today? If you need help with the uploaded files, please let me know your specific queries.\"\n }\n}\n\nThis API endpoint allows you to update the memory of an assistant. The HTTP POST request should be sent to https://api.trustbrand.ai/api/chat/assistants/memory with the raw request body type. The request payload should include the \"content\" key with the value representing the memory to be updated.
\nThe API endpoint allows you to Generate Image by sending an HTTP POST request to the specified URL.
\nThe response of this request is a JSON schema representing the structure of the response data. The schema will define the expected keys and their data types in the response.
\n{\n \"success\": true,\n \"message\": \"Fetch successfully\",\n \"data\": {\n \"data\": \"This is add memory test data\\n\\nHello! How can I assist you today? If you need help with the uploaded files, please let me know your specific queries.\"\n }\n}\n\nThe API endpoint allows you to delete by sending an HTTP DELETE request to the specified URL.
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Deleted successfully\"\n}\n\nThe API endpoint allows you to File Upload by sending an HTTP POST request to the specified URL. For uploading file we need to send data in form data.
\nfile (string): The file is the base64 we are adding in file (required)*
\nassistant_ids (string): The assistant_ids is the array of assistant_id we are sending (required)*
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Files uploaded successfully\"\n}\n\nResponse:
\n{\n \"success\": true,\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"first_name\": \"John\",\n \"last_name\": \"Wick\",\n \"email\": \"johnwick@gmail.com\",\n \"business_name\": \"The Continental Hotel\",\n \"phone_number\": \"\",\n \"Balance\": 0,\n \"country\": \"US\",\n \"createdAt\": \"2024-07-10T17:13:18.237Z\",\n \"updatedAt\": \"2024-12-20T10:43:05.613Z\"\n }\n}\n\nThe API endpoint allows you to Update Account by sending an HTTP PUT request to the specified URL.
\nemail (string): The email is that you want to change with the previos email (required)*
\nlast_name (string): The last_name you want to change with the previos last_name (required)*
\nfirst_name (string): The first_name you want to change with the previos first_name (required)*
\nResponse:
\n{\n \"success\": true,\n \"message\": \"accounts successfully updated\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"first_name\": \"John\",\n \"last_name\": \"Wick\",\n \"email\": \"johnwick@gmail.com\",\n \"business_name\": \"The Continental Hotel\",\n \"phone_number\": \"\",\n \"Balance\": 0,\n \"country\": \"US\",\n \"createdAt\": \"2024-07-10T17:13:18.237Z\",\n \"updatedAt\": \"2024-12-20T15:40:15.210Z\"\n }\n}\n\nThe API endpoint allows you to Create User by sending an HTTP POST request to the specified URL.
\nemail (string): The email is (required)*
\npassword (string): The password is (required)*
\nResponse:
\n{\n \"success\": true,\n \"message\": \"User added successfully\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"email\": \"johnwick@gmail.com\",\n \"password\": \"Penc1lKill\",\n \"createdAt\": \"2024-12-20T15:41:21.485Z\",\n \"updatedAt\": \"2024-12-20T15:41:21.485Z\"\n }\n}\n\nLimit Parameter Description:
The limit parameter specifies the number of records to fetch per API response. The value must be between 10 and 100.
Minimum value: 10
\nMaximum value: 100
\nPage Parameter Description:
\nThe page parameter specifies which page of records to retrieve when paginating through results. It is used in combination with the limit parameter to fetch specific subsets of data.
Default value: 1
Minimum value: 1
If a value outside this range is provided, the API will return an error
\nResponse:
\n{\n \"success\": true,\n \"message\": \"Users found successfully.\",\n \"totalPages\": 118,\n \"totalRecords\": 1178,\n \"currentPage\": 1,\n \"limit\": 10,\n \"data\": [\n {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"userName\": \"John Wick\",\n \"email\": \"johnwick@gmail.com\",\n \"createdAt\": \"2024-07-02T13:00:20.654Z\",\n \"updatedAt\": \"2024-10-16T15:17:35.932Z\"\n },\n]\n}\n\nThe API endpoint allows you to delete by sending an HTTP DELETE request to the specified URL. This is the query parameter we need
\nResponse:
\n{\n \"success\": true,\n \"message\": \"User deleted successfully\"\n}\n\nThe API endpoint allows you to Update User by sending an HTTP PUT request to the specified URL.
\n_Id (string): The _Id is that user _id which we want to update (required)*
\npassword (string): The password is (required)*
\nResponse:
\n{\n \"success\": true,\n \"message\": \"user successfully updated\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"userName\": \"John Wick\",\n \"email\": \"johnwick@example.com\",\n \"createdAt\": \"2024-07-02T13:00:20.654Z\",\n \"updatedAt\": \"2024-12-20T12:46:51.298Z\"\n }\n}\n\nThe API endpoint allows you to Get User By ID by sending an HTTP GET request to the specified URL. This is the query parameter we need
\nResponse:
\n{\n \"success\": true,\n \"message\": \"User found successfully\",\n \"data\": {\n \"_id\": \"a3f79b12d6c48e5f08ab34de\",\n \"userName\": \"John Wick\",\n \"email\": \"johnwick@gmail.com\",\n \"createdAt\": \"2024-07-02T13:22:06.252Z\",\n \"updatedAt\": \"2024-07-02T13:22:06.252Z\"\n }\n}\n\n