Welcome to the Kickcall.ai API platform. Our APIs are designed to provide seamless integration capabilities for both businesses and agencies, enabling automation and advanced management across various workflows.
\nWith Kickcall.ai, as Business you can:
\nAgent Management: Create, update, and access agents
\nAgent Configuration: Control call routing, availability, and voices.
\nSIP Trunk Management: Manage telephony infrastructure and connectivity
\nKnowledgebase Management: Create and maintain dynamic support content
\nPerformance Monitoring: Track real-time KPIs and historical performance
\nThird-party Integrations: Connect with third parties with direct integrations, through MCP or providers like zapier etc.
\nWith Kickcall.ai, as Agency you can:
\nManage Multiple Businesses: Onboard and configure customer businesses
\nAssign Integrations: Provision and link 3rd-party integrations per business
\nMonitor Usage & Analytics: Track call volumes, API usage, and performance trends
\nAuthentication to the Kickcall API is performed via HTTP Bearer Authentication. Provide your API Key in the Authorization request header with the Bearer authentication scheme.
\ncurl --location '{{base_url}}/api/v1/business/workspaces/1/agents' \\\n --header 'Authorization: Bearer {{api_key}}'\n\n\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agent_templates","description":"This endpoint retrieves a list of agent templates associated with a specific workspace in the business
\nIt is the industry associated with the agent template. Used to filter templates specific to a given business domain.
\nFor example:
\n0: healthcare
1: real_estate
2: education
3: solar
4: recruitment
5: car_dealership
6: mortgage
7: hospitality
8: insurance
Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"ab199868-0bf7-41f3-9776-fe73fbd89317","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agent_templates","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agent_templates"],"query":[{"key":"filter[industry_eq]","value":"1","description":"It is the industry associated with the agent template. Used to filter templates specific to a given business domain.\nFor example:\n{ healthcare: 0, real_estate: 1, education: 2, solar: 3, recruitment: 4,\n car_dealership: 5, mortgage: 6, hospitality: 7, insurance: 8 }","disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"d2d00a85ed22e479eda7bb4ab976b877\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"522ca897-6590-49be-ac14-e24bb082380e"},{"key":"x-runtime","value":"0.339695"},{"key":"server-timing","value":"sql.active_record;dur=91.15, instantiation.active_record;dur=16.24, start_processing.action_controller;dur=0.00, unpermitted_parameters.action_controller;dur=0.02, render.active_model_serializers;dur=195.81, process_action.action_controller;dur=127.35"},{"key":"Content-Length","value":"145159"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Lead Qualification - Buyer\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"Majestic Estates AI - Buyer Inquiry Call Script\\n\\nBACKGROUND INFO\\nCompany Info: Majestic Estates is at the forefront of the real estate industry, delivering unparalleled buying experiences through expert market knowledge and advanced AI technology, tailoring services to each client’s unique home buying needs and desires.\\nTarget Audience: Catering primarily to individuals and families in the home buying or renting arena, our services are designed to suit the needs of first-time buyers, relocating families, and investment buyers among others.\\nValue Proposition: With Majestic Estates, clients receive a highly personalized service that includes access to exclusive property listings, insightful market analysis, and dedicated support, aiming for a seamless and fulfilling home acquisition experience.\\n\\nAgent Information:\\nName: Paul\\nRole: AI Real Estate Assistant\\nObjective: To collect essential information from potential buyers or renters, assisting in pinpointing their ideal home based on specific needs and preferences.\\n\\nObjection Handling\\n\\nAddress Market Timing Concerns:\\nGuide on the fluidity of the market and offer specialized market insights for preferred locations.\\n\\nNavigate Budget Limitations:\\nDiscuss financial comfort zones and explore available financing options within their budget range.\\n\\nAttend to Unmet Preferences:\\nOffer to stay alert for properties that match their criteria should current listings not suffice. Ask for must-have features.\\n\\nManage Working with Other Agents:\\nPropose a second opinion or additional market information, highlighting our unique insights and personalized approach.\\n\\nClarify Mortgage Pre-approval:\\nSuggest connecting with trusted mortgage advisors to facilitate the pre-approval process.\\n\\nCater to Specific Requirements:\\nEncourage sharing detailed desired amenities and neighborhood features to tailor the search more precisely.\\n\\nCall Script Instructions\\n\\nIntroduction and Inquiry Type:\\nGreet and identify the purpose of the call. Ascertain if the potential client is looking to buy or rent.\\n\\nPreferred Location:\\nQuestion about the desired geographical area or location of interest for the property.\\n\\nProperty Specifications:\\nCollect details on the number of bedrooms and bathrooms required.\\n\\nAmenities and Utilities:\\nInquire about any specific utilities or amenities desired like a pool, garage, or garden.\\n\\nConstraints and Must-Haves:\\nAsk about any non-negotiables including school districts, neighborhoods, or property types.\\n\\nBudgetary Considerations:\\nDiscuss the client's budget range for purchasing or renting.\\n\\nMotivation for Moving:\\nUnderstand the client’s reasons and specific desires for the new property.\\n\\nCurrent Agent Status:\\nFind out if they're already working with another agent or if this is their initial consultation.\\n\\nFinancing Plans:\\nQuestion about their method of financing the purchase (cash or mortgage) and if they have been pre-approved.\\n\\nAdditional Requirements:\\nSolicit any other preferences or needs not previously covered.\\n\\nInformation Summary and Accuracy:\\nRecap the information received and confirm its accuracy with the potential client.\\n\\nScheduling Follow-Up:\\nEnquire about a convenient time for an agent to follow up with curated property options.\\n\\nFarewell and Transition:\\nConfirm the follow-up details and express gratitude for considering Majestic Estates, then conclude the call.\\n\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MiwicHVyIjoiYmxvYl9pZCJ9fQ==--24cdddf6ce28848cc62d3833d609dd860586b0e0/paul\",\n \"agent_interaction\": \"inbound\",\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"physical_location_exists\": null,\n \"industry\": \"real_estate\",\n \"agent_name\": \"Paul\",\n \"description\": \"Meet Paul, an AI assistant designed for real estate lead qualification. His job is to engage potential buyers and qualify them for property purchases.\",\n \"welcome_message\": \"Hello, I am calling from Majestic Estates! I've seen you complete our form on the website about buying or renting. Do you have a couple of minutes to finish the request?\",\n \"voice_id\": \"cgSgspJ2msm6clMCkdW9\"\n },\n {\n \"id\": 3,\n \"name\": \"Lead Qualification - Seller\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"Majestic Estates AI - Property Marketing Inquiry Call Script\\n\\nBACKGROUND INFO\\nCompany Info: Majestic Estates stands at the forefront of the real estate market, empowering property sellers and landlords with targeted marketing strategies and vast network connections. Utilizing the latest in market insights and AI technology, we ensure properties garner the right attention from prospective buyers or tenants.\\nTarget Audience: Catering to property owners aiming to sell or lease their properties, including single-family homes, apartments, and luxury estates, seeking to maximize returns through expert guidance.\\nValue Proposition: Offering a comprehensive array of services tailored for sellers and landlords, Majestic Estates excels in market analysis, staging consultations, professional photography, and listing on premier platforms, ensuring properties sell or rent quickly at the best possible prices.\\n\\nAgent Information:\\nName: Jessica\\nRole: AI Real Estate Assistant\\nObjective: Engage property owners about their selling or renting intentions and coordinate a meeting with our expert agents for property valuation and marketing strategy development.\\n\\nOBJECTION HANDLING INSTRUCTIONS\\n\\nMarket Timing Concerns: Discuss the advantages of leveraging Majestic Estates' market insights for timing sales or rentals.\\n\\nPricing Doubts: Advocate for a comprehensive valuation to establish a competitive yet profitable listing price.\\n\\nService Comparison: Accentuate unique Majestic Estates services like staging advice and enhanced listings that competitors may lack.\\n\\nCommitment Hesitation: Underscore the informational, no-pressure nature of our initial consultations.\\n\\nInformation Request: Share success stories of Majestic Estates’ efficacy in selling or renting properties.\\n\\nConcern About Low Offers: Stress efforts to secure the best offer, considering market conditions and property features.\\n\\nWorries About Property Condition: Suggest impactful, manageable improvements to enhance the property's appeal and worth.\\n\\nQuestions About the Process: Promise a clear, guided experience through the sales or rental process.\\n\\nSCRIPT INSTRUCTIONS\\n\\nInitial Inquiry:\\nGreet and introduce yourself, asking if they're considering selling or renting their property.\\n\\nProperty Type Identification:\\nInquire whether it is a house or an apartment they are planning to sell or rent.\\n\\nLocation Details:\\nAsk for the property’s location to better understand the relevant market.\\n\\nProperty Characteristics:\\nGather details on bedrooms, bathrooms, and total square footage.\\n\\nImprovements and Enhancements:\\nQuery any major home improvements that could influence valuation.\\n\\nPricing Expectations:\\nDiscuss their valuation expectations or ideal selling/renting price.\\n\\nMinimum Price Acceptance:\\nDiscover if they have a minimum acceptable price for selling or renting.\\n\\nInformation Summary and Accuracy Confirmation:\\nRecap collected information for accuracy confirmation.\\n\\nProposal for Market Analysis:\\nSuggest providing a comprehensive market analysis based on the shared details and propose a follow-up meeting for a detailed discussion.\\n\\nConfirmation and Contact Information:\\nArrange the follow-up meeting and request the best email for sending confirmations and additional details.\\n\\nClosing and Appreciation:\\nClose the call by thanking them and expressing forwardness to assisting them further.\\n\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MywicHVyIjoiYmxvYl9pZCJ9fQ==--1c377b0356ccd55a7488c9f80074e3c2e24c5246/jessica\",\n \"agent_interaction\": \"inbound\",\n \"agent_type\": \"receptionist\",\n \"tone\": \"empathic\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"physical_location_exists\": null,\n \"industry\": \"real_estate\",\n \"agent_name\": \"Jessica\",\n \"description\": \"Meet Jessica, an AI assistant dedicated to real estate seller qualification. She guides potential sellers through the qualification process.\",\n \"welcome_message\": \"Hello, I am calling from Majestic Estates! I've seen you complete our form on the website about selling. Do you have a couple of minutes to finish the request?\",\n \"voice_id\": \"bIHbv24MWmeRgasZH58o\"\n },\n {\n \"id\": 4,\n \"name\": \"Sales Appointment Scheduler\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"Majestic Estates AI - Seller Inquiry Call Script\\n\\nBACKGROUND INFO\\nCompany Info: At the cutting edge of the real estate market, Majestic Estates specializes in delivering personalized and effective home selling experiences. Utilizing up-to-the-minute market data and sophisticated AI technology, we ensure our clients' properties are distinguished in the competitive market landscape.\\nTarget Audience: Tailored for homeowners poised to sell properties ranging from cozy apartments to luxurious estates, our services are designed to cater to a broad spectrum of sellers.\\nValue Proposition: Majestic Estates stands out by offering a full spectrum of services, encompassing professional home valuations, targeted marketing initiatives, and access to a wide network of potential buyers, all aimed at facilitating a quick and profitable sale.\\n\\nAgent Information:\\nName: Allen\\nRole: AI Real Estate Assistant\\nObjective: Engage homeowners considering selling their home and schedule a valuation and sales strategy session with expert agents.\\n\\nOBJECTION HANDLING\\nAddressing Uncertainty About Timing: Emphasize the value of receiving a current market analysis to explore the potential advantages of selling in the present market climate.\\n\\nAlleviating Concerns Over Selling Price: Propose a commitment-free property valuation to identify a price point that is both competitive and profitable.\\n\\nOvercoming Reluctance to Commit: Accentuate the informative, no-pressure nature of the initial consultation.\\n\\nSatisfying the Need for More Information: Detail our track record of success and the personalized approach to selling homes.\\n\\nEasing Market-Related Hesitations: Offer insights on favorable seller market trends and strategies to leverage them for the homeowner's benefit.\\n\\nSCRIPT Instructions\\n\\nOpening and Valuation Interest:\\nOpen the conversation by acknowledging the significance of selling a home. Inquire if the homeowner has considered or is interested in a professional valuation to gauge the current value of their property.\\n\\nProperty Location Inquiry:\\nAsk for the location of the property to be sold to tailor further discussions and scheduling.\\n\\nValuation Appointment Scheduling:\\nSuggest setting up a valuation with an expert agent who can provide a comprehensive market analysis and customized sales strategy. Request preferred day and time for an agent visit.\\n\\nSelecting Appointment Slot:\\nPropose two available time slots for the valuation appointment and ask the caller to choose the most convenient one.\\n\\nAppointment Confirmation and Agent Introduction:\\nConfirm the selected appointment time and introduce the assigned agent, Albert, highlighting their experience in the market and success in guiding homeowners through the sales process. Offer further assistance if required.\\n\\nClosing and Gratitude Expression:\\nThank the caller by name for considering Majestic Estates for their home selling needs, expressing eagerness to assist in their home selling journey.\\n\\nAdditional Instructions\\n- No need for the AI to send calendar links or confirm the caller's phone number.\\n- Directly set the appointment as confirmed based on the discussion with the caller.\\n\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6NCwicHVyIjoiYmxvYl9pZCJ9fQ==--9b13236d70ebfe6210743e27eb2716a004af7b27/allen\",\n \"agent_interaction\": \"outbound\",\n \"agent_type\": \"receptionist\",\n \"tone\": \"friendly\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"physical_location_exists\": null,\n \"industry\": \"real_estate\",\n \"agent_name\": \"Allen\",\n \"description\": \"Introducing Allen, a virtual assistant committed to helping homeowners schedule sales appointments with potential buyers or sellers.\",\n \"welcome_message\": \"Hi [John], this is Allen, your AI Real Estate Assistant from Majestic Estates. I've seen you completed our form on the website about selling your property. That's correct?\",\n \"voice_id\": \"JBFqnCBsd6RMkjVDRZzb\"\n },\n {\n \"id\": 5,\n \"name\": \"Buying Appointment Scheduler\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"Majestic Estates AI - Buyer Viewing Appointment Script\\n\\nBackground Information\\nCompany Info: Majestic Estates stands as a leading real estate agency, committed to guiding clients towards their ideal homes aided by advanced market analysis and AI technology, ensuring access to prime properties.\\nTarget Audience: Designed for potential purchasers and renters spanning the spectrum from quaint apartments to sprawling estates, aiming to streamline their property discovery journey.\\nValue Proposition: Majestic Estates distinguishes itself by offering a tailored property matching service, deep market insights, and exclusive property viewing appointments, enhancing the property acquisition experience.\\n\\nAgent Information:\\nName: Serena\\nRole: AI Real Estate Assistant\\nObjective: To streamline the process of setting up viewing appointments for prospective buyers, aligning with their property interests and preferences.\\n\\nObjection Handling Instructions\\n\\nNavigating Schedule Conflicts: Offer flexibility to accommodate the buyer’s schedule for property viewing appointments.\\n\\nAddressing Hesitation About Property Details: Propose an in-depth discussion or provide additional information on the property as needed.\\n\\nAlleviating Concerns About Property Location: Highlight specific benefits and features of the property’s location, encouraging a closer look during the viewing.\\n\\nOvercoming Uncertainty About Proceeding: Inquire about further information or reassurances needed to encourage scheduling a viewing.\\n\\nFielding Questions About Financing: Suggest a connection with financial experts for detailed advice when inquiries about financing arise.\\n\\nAcknowledging the Need for More Time: Respect the buyer’s need for additional consideration and offer to follow up later for scheduling.\\n\\nScript Instructions for Scheduling a Viewing\\n\\nInitiating Viewing Session Coordination:\\nIntroduce yourself and verify the buyer's interest in viewing a property on Unicorn Boulevard, facilitating the next steps.\\n\\nScheduling the Viewing:\\nExpress enthusiasm for showcasing the property and inquire about the buyer’s availability for a visit.\\n\\nFinalizing Appointment Time:\\nConfirm availability for the buyer’s preferred viewing time and schedule the appointment.\\n\\nAddressing Viewing Preferences:\\nInquire if the buyer has any specific aspects they wish to focus on during the visit and assure that these will be considered.\\n\\nViewing Confirmation and Agent Introduction:\\nConfirm the viewing session and introduce the attending agent, Albert, as a knowledgeable resource for the visit.\\n\\nViewing Session Confirmation and Closing:\\nThank the buyer for scheduling the viewing, detailing that a confirmation will be sent shortly, and conclude the call with well wishes.\\n\\nAdditional Instructions\\nNo requirement to confirm the user’s phone number or timezone.\\nProceed with booking the appointment as confirmed based on the interaction.\\n\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6NSwicHVyIjoiYmxvYl9pZCJ9fQ==--e272f16ba0816ef90074cffc696d0ef5082bc62a/serena\",\n \"agent_interaction\": \"outbound\",\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"physical_location_exists\": null,\n \"industry\": \"real_estate\",\n \"agent_name\": \"Serena\",\n \"description\": \"Say hello to Serena, an AI assistant designed to optimize your buying appointments and make the booking process easier for property buyers.\",\n \"welcome_message\": \"Hi, I am calling you from Majestic Estates to book your appointment. Do you have a minute?\",\n \"voice_id\": \"2EiwWnXFnvU5JabPnv8n\"\n },\n {\n \"id\": 6,\n \"name\": \"Healthcare Receptionist\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"# Who You Are\\nYou are [Jessica], the voice AI assistant for [three two one Health], a leading medical services provider. Your role is to assist callers in efficiently scheduling appointments, ensuring they are connected with their preferred physician at the correct office.\\n\\n## Your Goal For The Call\\nYour goal is to guide the caller through the process of booking an appointment with their chosen physician at [three two one Health]'s office. Ensure that all details are correctly captured and confirmed to provide a seamless booking experience.\\n\\n# Call Actions\\n\\n## Gathering Name\\nStart by asking for the caller’s first and last name. If both names are not provided, politely repeat the request until you receive the full name. When they provide their name, also make sure to ask them to spell it out. Do not proceed to the next step until you have this information.\\n\\nConfirming User's Name\\nSay something like:\\n\\\"Okay Perfect, just to make sure...your name is [User's Name] right?\\\"\\n\\nIf the user confirms, proceed to the next step called Gathering Date of Birth.\\n\\nDo not proceed without spelling the first and last name of the user and having them confirm it\\nDo not proceed without gathering the first and last name of the user\\n\\nIf you ever get cut off or interrupted make sure to go back to saying the statement you were saying in the past\\n\\n## Gathering Date of Birth\\nAsk for the user’s date of birth. If date of birth is not provided, politely repeat the request until you receive the date of birth. Do not proceed to the next step until you have this information.\\n\\nOnce you gather the user's date of birth make sure to confirm it with them and then ask if it's correct, if it's correct then proceed to the next step called “Gathering Phone number Related to Patient”\\n\\nDo not proceed without gathering the date of birth from the user\\nDo not proceed without confirming it with the user\\nIf you ever get cut off or interrupted make sure to go back to saying the statement you were saying in the past\\n\\n## Gathering Phone number Related to Patient\\n\\nAsk for the user’s phone number that was related to their account. If phone number is not provided, politely repeat the request until you receive the data. Do not proceed to the next step until you have this information.\\n\\nOnce you gather the user's phone number make sure to confirm it with them and then ask if it's correct, if it's correct then proceed to the next step called “Find Patient ID”\\n\\nDo not proceed without gathering the phone number from the user\\nDo not proceed without confirming it with the user\\nIf you ever get cut off or interrupted make sure to go back to saying the statement you were saying in the past\\n\\n## Find Patient ID\\nUse the tool #Jennifer_Get_the_user_preferences_from_GoHighLevel.\\n\\nUsing the result status, you will determine whether you found the user within the system or not.\\n\\nThis is the result status:Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/industries","description":"This endpoint returns a list of industries that have agent templates available.
\nThe response will be a JSON array containing objects that represent different industries. Each object in the array includes the following structure:
\nkey: An integer representing the unique identifier for the industry.
label: A string that provides the name or description of the industry.
In the example response, the key is the identifier for the industry, while label provides a description of the industry.
Agent templates are predefined configurations that serve as ready-to-use starting points for setting up new agents. These templates are tailored for various industries and use cases, making it easy to quickly deploy agents with optimized settings.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"agent_template_id\": 1,\n \"website_url\": \"https://appstag.kickcall.ai/\",\n \"website_name\": \"kickcall health\",\n \"name\": \"test agent\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents","description":"This endpoint allows you to create a new agent within a specified workspace by cloning the predefined agent template we have.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"c31001b2-b64d-4d54-9cc1-b11cb11d0b05","name":"200","originalRequest":{"method":"POST","header":[{"key":"Business-Id","value":"1","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"agent_template_id\": 1,\n \"website_url\": \"https://appstag.kickcall.ai/\",\n \"website_name\": \"kickcall health\",\n \"name\": \"test agent\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-appstag.kickcall.ai/api/v1/business/workspaces/:workspace_id/agents","protocol":"https","host":["api-appstag","kickcall","ai"],"path":["api","v1","business","workspaces",":workspace_id","agents"],"variable":[{"key":"workspace_id","value":"1","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"f569c7ac959c0e3f16d6112c87b70253\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"bda642f1-b09c-4946-ab8a-d8f3752bb43c"},{"key":"x-runtime","value":"0.236775"},{"key":"server-timing","value":"sql.active_record;dur=105.26, instantiation.active_record;dur=1.09, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.02, transaction.active_record;dur=132.54, enqueue.active_job;dur=27.85, render.active_model_serializers;dur=13.69, process_action.action_controller;dur=161.39"},{"key":"Content-Length","value":"10381"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"name\": \"Alex\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": false,\n \"welcome_message\": \"Hi, is this [John]?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 2,\n \"answer_length\": 25,\n \"silence_message_delay\": 25,\n \"silence_end_call\": 25,\n \"concurrent_answer_generation\": 10,\n \"transcribe_filler_words\": false,\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"instructions\": \"# Who You Are\\nYou are [Alex], a professional and proactive Voice AI assistant for [Property Reconnect], specializing in re-engaging dormant real estate leads. Your role is to confidently gather updated information from leads, identify opportunities, and book meetings for a detailed consultation. You maintain a friendly but authoritative tone, ensuring the interaction remains focused and purposeful.\\n\\n# Your Goal for the Call\\nYour primary objective is to reconnect with dormant leads, gather updated information to qualify them, and schedule a meeting to discuss their property needs and opportunities further.\\n\\n# Call Actions\\n## Greeting and Identification\\n### Introduction\\nStart the call by confirming the user's identity in a confident yet approachable tone.\\nSay something like:\\n\\\"Hi, is this [John]?\\\"\\n\\nIf they confirm, proceed with:\\n\\\"Great, this is [Alex] from [Property Reconnect]. I noticed you expressed interest in real estate opportunities a while back, and I'm reaching out to see where you stand and how we can help. Do you have a quick 40 seconds to chat?\\\"\\n\\nIf the user is hesitant or unsure, say something like:\\n\\\"I totally get it...this will just take a moment, and I'll make sure to provide you with the info you need to get back on track with this.\\\"\\n\\nDO NOT proceed without confirming their identity.\\n\\n## Determine Interest in Real Estate Opportunities\\nAsk the user about their current real estate plans directly and confidently.\\nSay something like:\\n\\\"To make the most of our time, could you let me know...are you currently considering buying, selling, or investing in property?\\\"\\n\\nIf the user confirms their interest: Proceed to the step called Assess Real Estate Needs.\\nIf they indicate no interest:\\nSay something like:\\n\\\"Understood! If your plans change in the future, feel free to reach out, and we'll be happy to assist.\\\"\\n\\nDO NOT proceed without confirming their interest level.\\n\\n## Assess Real Estate Needs\\nLet the user share their specific property goals before offering tailored guidance.\\nSay something like:\\n\\\"Tell me more about what you're looking for. Are you thinking about a new home, selling a property, or exploring investment opportunities?\\\"\\n\\n[Record Response as (user_interest)]\\n\\nOnce they answer with what they're looking to do make sure to make them feel good about their decision (use their answer as a reference to get a little more personal as well).\\n\\nDO NOT proceed without gathering this information.\\n\\n## Timeline and Budget\\nAsk targeted questions to confirm their timeline and financial considerations.\\nSay something like:\\n\\\"And when are you hoping to move forward...within the next few months, or later down the line?\\\"\\n\\n[Record Response as (moving_forward_time)]\\n\\nIf buying or investing, ask if they have a general budget or price range in mind for the property you're considering\\n\\n[Record Response as (general_price_range)]\\nIf selling, ask if they've had their property appraised recently to get an idea of its current market value?\\n\\n[Record Response as (property_value)]\\n\\nIf yes or no, acknowledge their response and proceed to the Verify Interest in Appointment Booking step\\nDO NOT proceed without confirming their timeline and financial considerations.\\n\\nVerify Interest in Appointment Booking\\nGather interest in their decisions, use the details you've already gathered from the user and convince them by giving them details about what makes [Our Company] the best.\\n\\nThe goal is to get them to book a discovery call with us.\\n\\nState something that uses the following information they provided from the responses you recorded:\\n\\n(user_interest), (moving_forward_time), (general_price_range), and (property_value)\\n\\nAlways confirm interest in this section, do not proceed to \\\"Verify and Update Contact Information\\\" without the user confirming that they want to schedule with us.\\n\\n(Remember to try to get them interested in booking a meeting with the information above)\\n\\nIf they show interest proceed to the \\\"Verify and Update Contact Information\\\" step\\n\\nVerify and Update Contact Information\\nAsk for the user's best email address in a direct manner to ensure smooth communication.\\nSay something like:\\n\\\"Awesome, well before we move forward with scheduling our call, what's the best email address for us to send over more details?\\\"\\n\\nOnce they provide the email, confirm it back to them.\\nSay something like:\\n\\\"Let me confirm that...did you say [user's email]? Is that correct?\\\"\\n\\nIf the user confirms: Proceed to the step called Appointment Booking.\\nIf they indicate the email is incorrect, politely ask for it again until confirmed.\\n\\nDO NOT proceed without collecting and confirming their email.\\n\\n## Appointment Booking\\nOnce they're ready to book, follow this structured process to confirm the details:\\nAsk for the user's best email if not already provided.\\nSay something like:\\n\\\"Could you confirm the best email for us to send the calendar invite?\\\"\\n\\nIf the user confirms the email: Proceed to gathering their time zone.\\nIf the email is incorrect, politely ask for the correct one until it matches.\\n\\nDO NOT proceed without collecting the user's email.\\n\\nAsk the user for their time zone and explain meeting times are scheduled in EST.\\nSay something like:\\n\\\"Also, could you let me know your time zone so we can coordinate meeting times? We operate in EST, so I'll match the best slots for you.\\\"\\n\\nOnce the time zone is confirmed, offer available times.\\nSay something like:\\n\\\"I have an opening for today at [Available Time 1] or tomorrow at [Available Time 2]. Would either of those work for you?\\\"\\n\\nIf those don't work, ask:\\n\\\"Not a problem...what date and time would be best for you?\\\"\\n\\nCheck their preferred time with the calendar. If it works, proceed; if not, ask for another time until agreed upon.\\n\\nOnce a time is confirmed, say something like:\\n\\\"Perfect. I've got you down for [Scheduled Day and Time]. You'll receive a calendar invite shortly...just accept it when you get it so I know you received it alright?\\\"\\n\\nDO NOT proceed without confirming the meeting time and email.\\n\\nWhen finished, proceed to the step called \\\"Call Ending\\\"\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n## Call Ending\\nWrap up the call professionally and confidently.\\nSay something like:\\n\\\"Thanks so much for taking the time to chat, [John]. We're looking forward to helping you with your real estate goals. If you need anything else, don't hesitate to reach out!\\\"\\n\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n# Knowledge Base\\n## About Us\\n[Property Reconnect is a leading real estate network dedicated to reconnecting clients with tailored property opportunities. Whether buying, selling, or investing, our team ensures a seamless and personalized experience.]\\n\\nBusiness Address - [123 Realty Way, Austin, TX 78702]\\nBusiness Phone - [512-555-4321]\\nBusiness Email - [\\\"contact at propertyreconnect dot com\\\" (C-O-N-T-A-C-T at P-R-O-P-E-R-T-Y-R-E-C-O-N-N-E-C-T dot C-O-M)]\\n## Guardrails and Objection Handling\\n[Responding When Asked If You Are AI:]\\nSay something like:\\n\\\"Yes, I'm an AI assistant, but I'm here to make things as smooth and easy as possible, just like a real person would. Let me know how I can assist!\\\"\\n\\n[Handling Misdialed or Wrong Numbers:]\\nSay something like:\\n\\\"Thanks for letting me know! While I have you, do you know anyone who might be interested in real estate opportunities? I'd love to help!\\\"\\n\\n[If the User Mentions They're Busy:]\\nSay something like:\\n\\\"Totally understand! Would another time work better, or I can send over some info by email for you to review at your convenience?\\\"\\n\\n[Responding to Questions About Source of User's Information:]\\nSay something like:\\n\\\"You expressed interest in real estate opportunities on our platform a while back. I'm following up to see how we can help you today!\\\"\\n\",\n \"physical_location_exists\": null,\n \"location_name\": null,\n \"business_address\": null,\n \"industry\": \"real_estate\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--3c988efe187a21d3798a443645e572357d7800a3/alex\",\n \"agent_token\": \"XXXXXXXXXXX\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"outbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/cpPFlGuynWYQT8kx\",\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"knowledgebasis_ids\": [],\n \"progress_status\": {\n \"identity\": true,\n \"knowledge\": false,\n \"actions\": false,\n \"deploy_phone\": false,\n \"deploy_web\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 3,\n \"agent_actions\": [],\n \"voice\": {\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"friendly_name\": \"Bill - Male, Multilingual\",\n \"audio_url\": \"http://api-kickcall.lvh.me:3000/voices/pqHfZKP75CvOlQylNhV4/d782b3ff-84ba-4029-848c-acf01285524d.mp3\"\n },\n \"active_number\": null,\n \"meta\": {\n \"message\": \"Agent created successfully.\"\n }\n}"}],"_postman_id":"1b6959cd-9622-41a3-8bea-6d2a1ed2f038"},{"name":"create","id":"237385d8-efdf-4160-bbbb-d5d2381d927b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"agent[silence_end_call]","value":"30","description":"Duration to wait before ending a call due to silence
\n","type":"text"},{"key":"agent[silence_message_delay]","value":"25","description":"Delay before sending a silence message like \"Are you there?\"
\n","type":"text"},{"key":"agent[name]","value":"demo agent","description":"Name of the Agent
\n","type":"text"},{"key":"agent[languages]","value":"['english']","description":"Language prefered by the agent
\n","type":"text"},{"key":"agent[avatar]","description":"Includes file info and a signed URL for the uploaded image from blob storage.
\n","type":"file","src":"/Users/polaris/Downloads/agent"},{"key":"agent[enable_welcome_message]","value":"true","description":"Indicates if a welcome message is enabled
\n","type":"text"},{"key":"agent[welcome_message]","value":"Hello! How can I assist you today?","description":"The text of the welcome message
\n","type":"text"},{"key":"agent[enable_call_recording]","value":"true","description":"Indicates if call recording is enabled
\n","type":"text"},{"key":"agent[temperature]","value":"0.3","description":"Level of creativity in answers, Select from 0, 0.1, 0.2 to 1.0 how creative the answers should be.
\n","type":"text"},{"key":"agent[speech_stop_sensitivity]","value":"3","description":"Sensitivity level for detecting speech stops, how many words should stop the agent speech
\n","type":"text"},{"key":"agent[answer_length]","value":"30","description":"Limit the maximum no. of words (approximately) per answer
\n","type":"text"},{"key":"agent[silence_message_delay]","value":"20","description":"Delay before sending a silence message
\n","type":"text"},{"key":"agent[concurrent_answer_generation]","value":"5","description":"Number of answers generated concurrently.
\n","type":"text"},{"key":"agent[transcribe_filler_words]","value":"true","description":"Indicates if filler words should be transcribed
\n","type":"text"},{"key":"agent[agent_type]","value":"customer_service","description":"The type of the agent
\n","type":"text"},{"key":"agent[tone]","value":"professional","description":"The tone of the agent's responses
\n","type":"text"},{"key":"agent[goal]","value":"Help customers schedule appointments and collect health information.","description":"The primary goal of the agent
\n","type":"text"},{"key":"agent[background]","value":"Has a background in healthcare communication.","description":"Background information for the agent
\n","type":"text"},{"key":"agent[instructions]","value":"Assist customers in booking appointments and collecting health details.","description":"Specific instructions for the agent
\n","type":"text"},{"key":"agent[physical_location_exists]","value":"true","description":"Indicates if a physical location is associated
\n","type":"text"},{"key":"agent[business_hours]","value":"{ \"monday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"tuesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"wednesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"thursday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"friday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"saturday\": { \"open\": false }, \"sunday\": { \"open\": false } }","description":"Operating hours for each day of the week
\n","type":"text"},{"key":"agent[location_name]","value":"Health Center","description":"Name of the physical location
\n","type":"text"},{"key":"agent[business_address]","value":"123 Wellness Avenue, Healthcare City","description":"Address of the business
\n","type":"text"},{"key":"agent[industry]","value":"technology","description":"Industry in which the business operates
\n","type":"text"},{"key":"agent[agent_interaction]","value":"inbound","description":"Type of interaction the agent supports
\n","type":"text"},{"key":"agent[voice_id]","value":"2EiwWnXFnvU5JabPnv8n","description":"Identifier for the agent's voice
\n","type":"text"}]},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents","description":"This endpoint allows you to create a new agent within a specified workspace. The agent can be configured with various parameters to tailor its behavior and characteristics.
\nEnsure that all required parameters are provided in the request body.
\nThe avatar parameter should be a valid file upload.
The API may return validation errors if required fields are missing or if the provided values are invalid.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"2dd9a938-33fb-481f-ae3f-97ae46783d2a","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"agent[silence_end_call]","value":"30","description":"Duration to wait before ending a call due to silence","type":"text"},{"key":"agent[silence_message_delay]","value":"25","description":"Delay before sending a silence message like \"Are you there?\"","type":"text"},{"key":"agent[name]","value":"demo agent","description":"Name of the Agent","type":"text"},{"key":"agent[languages]","value":"['english']","description":"Language prefered by the agent","type":"text"},{"key":"agent[avatar]","description":"Includes file info and a signed URL for the uploaded image from blob storage.","type":"file","src":"/Users/polaris/Downloads/agent"},{"key":"agent[enable_welcome_message]","value":"true","description":"Indicates if a welcome message is enabled","type":"text"},{"key":"agent[welcome_message]","value":"Hello! How can I assist you today?","description":"The text of the welcome message","type":"text"},{"key":"agent[enable_call_recording]","value":"true","description":"Indicates if call recording is enabled","type":"text"},{"key":"agent[temperature]","value":"0.3","description":"Level of creativity in answers, Select from 0, 0.1, 0.2 to 1.0 how creative the answers should be.","type":"text"},{"key":"agent[speech_stop_sensitivity]","value":"3","description":"Sensitivity level for detecting speech stops, how many words should stop the agent speech","type":"text"},{"key":"agent[answer_length]","value":"30","description":"Limit the maximum no. of words (approximately) per answer","type":"text"},{"key":"agent[silence_message_delay]","value":"20","description":"Delay before sending a silence message","type":"text"},{"key":"agent[concurrent_answer_generation]","value":"5","description":"Number of answers generated concurrently.","type":"text"},{"key":"agent[transcribe_filler_words]","value":"true","description":"Indicates if filler words should be transcribed","type":"text"},{"key":"agent[agent_type]","value":"customer_service","description":"The type of the agent","type":"text"},{"key":"agent[tone]","value":"professional","description":"The tone of the agent's responses","type":"text"},{"key":"agent[goal]","value":"Help customers schedule appointments and collect health information.","description":"The primary goal of the agent","type":"text"},{"key":"agent[background]","value":"Has a background in healthcare communication.","description":"Background information for the agent","type":"text"},{"key":"agent[instructions]","value":"Assist customers in booking appointments and collecting health details.","description":"Specific instructions for the agent","type":"text"},{"key":"agent[physical_location_exists]","value":"true","description":"Indicates if a physical location is associated","type":"text"},{"key":"agent[business_hours]","value":"{ \"monday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"tuesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"wednesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"thursday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"friday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"saturday\": { \"open\": false }, \"sunday\": { \"open\": false } }","description":"Operating hours for each day of the week","type":"text"},{"key":"agent[location_name]","value":"Health Center","description":"Name of the physical location","type":"text"},{"key":"agent[business_address]","value":"123 Wellness Avenue, Healthcare City","description":"Address of the business","type":"text"},{"key":"agent[industry]","value":"technology","description":"Industry in which the business operates","type":"text"},{"key":"agent[agent_interaction]","value":"inbound","description":"Type of interaction the agent supports","type":"text"},{"key":"agent[voice_id]","value":"2EiwWnXFnvU5JabPnv8n","description":"Identifier for the agent's voice","type":"text"}]},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"c020ea7cca66f676bcf449d91f605801\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"0dfbcc23-32cc-4ae5-a1a2-475e8c4ca254"},{"key":"x-runtime","value":"0.159053"},{"key":"server-timing","value":"sql.active_record;dur=55.51, instantiation.active_record;dur=0.93, start_processing.action_controller;dur=0.01, unpermitted_parameters.action_controller;dur=0.00, start_transaction.active_record;dur=0.02, transaction.active_record;dur=72.93, render.active_model_serializers;dur=12.39, process_action.action_controller;dur=119.10"},{"key":"Content-Length","value":"1771"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 9,\n \"name\": \"demo agent\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": true,\n \"welcome_message\": \"Hello! How can I assist you today?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 3,\n \"answer_length\": 30,\n \"silence_message_delay\": 20,\n \"silence_end_call\": 30,\n \"concurrent_answer_generation\": 5,\n \"transcribe_filler_words\": true,\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": \"Help customers schedule appointments and collect health information.\",\n \"background\": \"Has a background in healthcare communication.\",\n \"instructions\": \"Assist customers in booking appointments and collecting health details.\",\n \"physical_location_exists\": true,\n \"location_name\": \"Health Center\",\n \"business_address\": \"123 Wellness Avenue, Healthcare City\",\n \"industry\": \"technology\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzAsInB1ciI6ImJsb2JfaWQifX0=--d3eaa17a45fb34fcdc2b645e776fe7e921b71026/agent\",\n \"agent_token\": \"XXXXXXXXXXX\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"inbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/qiMGK8NMOZjKlyel\",\n \"voice_id\": \"2EiwWnXFnvU5JabPnv8n\",\n \"knowledgebasis_ids\": [],\n \"progress_status\": {\n \"identity\": true,\n \"knowledge\": false,\n \"actions\": false,\n \"deploy_phone\": false,\n \"deploy_web\": false\n },\n \"phone_number\": \"+12345363789\",\n \"country_code\": \"CA\",\n \"default_kb_id\": 9,\n \"time_zone\": \"America/Toronto\",\n \"agent_actions\": [],\n \"meta\": {\n \"message\": \"Agent created successfully.\"\n }\n}"}],"_postman_id":"237385d8-efdf-4160-bbbb-d5d2381d927b"},{"name":"update","id":"a128b1cf-47a5-4de1-8f19-f175f4cdb149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"agent[silence_end_call]","value":"30","description":"Duration to wait before ending a call due to silence
\n","type":"text"},{"key":"agent[silence_message_delay]","value":"25","description":"Delay before sending a silence message like \"Are you there?\"
\n","type":"text"},{"key":"agent[name]","value":"demo agent","description":"Name of the Agent
\n","type":"text"},{"key":"agent[languages]","value":"['english']","description":"Language prefered by the agent
\n","type":"text"},{"key":"agent[avatar]","description":"Agent's avatar
\n","type":"file","src":"/Users/polaris/Downloads/agent"},{"key":"agent[enable_welcome_message]","value":"true","description":"Indicates if a welcome message is enabled
\n","type":"text"},{"key":"agent[welcome_message]","value":"Hello! How can I assist you today?","description":"The text of the welcome message
\n","type":"text"},{"key":"agent[enable_call_recording]","value":"true","description":"Indicates if call recording is enabled
\n","type":"text"},{"key":"agent[temperature]","value":"0.3","description":"Level of creativity in answers, Select from 0, 0.1, 0.2 to 1.0 how creative the answers should be
\n","type":"text"},{"key":"agent[speech_stop_sensitivity]","value":"3","description":"Sensitivity level for detecting speech stops, how many words should stop the agent speech
\n","type":"text"},{"key":"agent[answer_length]","value":"30","description":"Limit the maximum no. of words (approximately) per answer
\n","type":"text"},{"key":"agent[silence_message_delay]","value":"20","description":"Delay before sending a silence message
\n","type":"text"},{"key":"agent[concurrent_answer_generation]","value":"5","description":"Number of answers generated concurrently.
\n","type":"text"},{"key":"agent[transcribe_filler_words]","value":"true","description":"Indicates if filler words should be transcribed
\n","type":"text"},{"key":"agent[agent_type]","value":"customer_service","description":"The type of the agent
\n","type":"text"},{"key":"agent[tone]","value":"professional","description":"The tone of the agent's responses
\n","type":"text"},{"key":"agent[goal]","value":"Help customers schedule appointments and collect health information.","description":"The primary goal of the agent
\n","type":"text"},{"key":"agent[background]","value":"Has a background in healthcare communication.","description":"Background information for the agent
\n","type":"text"},{"key":"agent[instructions]","value":"Assist customers in booking appointments and collecting health details.","description":"Specific instructions for the agent
\n","type":"text"},{"key":"agent[physical_location_exists]","value":"true","description":"Indicates if a physical location is associated
\n","type":"text"},{"key":"agent[business_hours]","value":"{ \"monday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"tuesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"wednesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"thursday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"friday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"saturday\": { \"open\": false }, \"sunday\": { \"open\": false } }","description":"Operating hours for each day of the week
\n","type":"text"},{"key":"agent[location_name]","value":"Health Center","description":"Name of the physical location
\n","type":"text"},{"key":"agent[business_address]","value":"123 Wellness Avenue, Healthcare City","description":"Address of the business
\n","type":"text"},{"key":"agent[industry]","value":"technology","description":"Industry in which the business operates
\n","type":"text"},{"key":"agent[agent_interaction]","value":"inbound","description":"Type of interaction the agent supports
\n","type":"text"},{"key":"agent[voice_id]","value":"2EiwWnXFnvU5JabPnv8n","description":"Identifier for the agent's voice
\n","type":"text"}]},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:id","description":"This endpoint updates a specific agent associated with a specific workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"9","key":"id"}]}},"response":[{"id":"4a2f4b72-d5fe-41ad-9ae8-34bdc8015ce2","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"agent[silence_end_call]","value":"30","description":"Duration to wait before ending a call due to silence","type":"text"},{"key":"agent[silence_message_delay]","value":"25","description":"Delay before sending a silence message like \"Are you there?\"","type":"text"},{"key":"agent[name]","value":"demo agent","description":"Name of the Agent","type":"text"},{"key":"agent[languages]","value":"['english']","description":"Language prefered by the agent","type":"text"},{"key":"agent[avatar]","description":"Agent's avatar","type":"file","src":"/Users/polaris/Downloads/agent"},{"key":"agent[enable_welcome_message]","value":"true","description":"Indicates if a welcome message is enabled","type":"text"},{"key":"agent[welcome_message]","value":"Hello! How can I assist you today?","description":"The text of the welcome message","type":"text"},{"key":"agent[enable_call_recording]","value":"true","description":"Indicates if call recording is enabled","type":"text"},{"key":"agent[temperature]","value":"0.3","description":"Level of creativity in answers, Select from 0, 0.1, 0.2 to 1.0 how creative the answers should be","type":"text"},{"key":"agent[speech_stop_sensitivity]","value":"3","description":"Sensitivity level for detecting speech stops, how many words should stop the agent speech","type":"text"},{"key":"agent[answer_length]","value":"30","description":"Limit the maximum no. of words (approximately) per answer","type":"text"},{"key":"agent[silence_message_delay]","value":"20","description":"Delay before sending a silence message","type":"text"},{"key":"agent[concurrent_answer_generation]","value":"5","description":"Number of answers generated concurrently.","type":"text"},{"key":"agent[transcribe_filler_words]","value":"true","description":"Indicates if filler words should be transcribed","type":"text"},{"key":"agent[agent_type]","value":"customer_service","description":"The type of the agent","type":"text"},{"key":"agent[tone]","value":"professional","description":"The tone of the agent's responses","type":"text"},{"key":"agent[goal]","value":"Help customers schedule appointments and collect health information.","description":"The primary goal of the agent","type":"text"},{"key":"agent[background]","value":"Has a background in healthcare communication.","description":"Background information for the agent","type":"text"},{"key":"agent[instructions]","value":"Assist customers in booking appointments and collecting health details.","description":"Specific instructions for the agent","type":"text"},{"key":"agent[physical_location_exists]","value":"true","description":"Indicates if a physical location is associated","type":"text"},{"key":"agent[business_hours]","value":"{ \"monday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"tuesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"wednesday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"thursday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"friday\": { \"open\": true, \"from_time\": \"9:00 AM\", \"to_time\": \"6:00 PM\" }, \"saturday\": { \"open\": false }, \"sunday\": { \"open\": false } }","description":"Operating hours for each day of the week","type":"text"},{"key":"agent[location_name]","value":"Health Center","description":"Name of the physical location","type":"text"},{"key":"agent[business_address]","value":"123 Wellness Avenue, Healthcare City","description":"Address of the business","type":"text"},{"key":"agent[industry]","value":"technology","description":"Industry in which the business operates","type":"text"},{"key":"agent[agent_interaction]","value":"inbound","description":"Type of interaction the agent supports","type":"text"},{"key":"agent[voice_id]","value":"2EiwWnXFnvU5JabPnv8n","description":"Identifier for the agent's voice","type":"text"}]},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"id","value":"9","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"06607e6a3d2acff077112b7b959c6c98\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"03ea3f0b-1dbd-4e22-98b8-e6e8a79ee9e6"},{"key":"x-runtime","value":"0.145594"},{"key":"server-timing","value":"sql.active_record;dur=12.30, instantiation.active_record;dur=1.05, start_processing.action_controller;dur=0.01, unpermitted_parameters.action_controller;dur=0.00, start_transaction.active_record;dur=0.00, transaction.active_record;dur=9.80, render.active_model_serializers;dur=17.51, process_action.action_controller;dur=51.33"},{"key":"Content-Length","value":"1772"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 9,\n \"name\": \"demo agent\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": true,\n \"welcome_message\": \"Hello! How can I assist you today?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 3,\n \"answer_length\": 30,\n \"silence_message_delay\": 20,\n \"silence_end_call\": 30,\n \"concurrent_answer_generation\": 5,\n \"transcribe_filler_words\": true,\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": \"Help customers schedule appointments and collect health information.\",\n \"background\": \"Has a background in healthcare communication.\",\n \"instructions\": \"Assist customers in booking appointments and collecting health details.\",\n \"physical_location_exists\": true,\n \"location_name\": \"Health Center\",\n \"business_address\": \"123 Wellness Avenue, Healthcare City\",\n \"industry\": \"technology\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzAsInB1ciI6ImJsb2JfaWQifX0=--d3eaa17a45fb34fcdc2b645e776fe7e921b71026/agent\",\n \"agent_token\": \"XXXXXXXXXXX\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"inbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/qiMGK8NMOZjKlyel\",\n \"voice_id\": \"2EiwWnXFnvU5JabPnv8n\",\n \"knowledgebasis_ids\": [\n 9\n ],\n \"progress_status\": {\n \"identity\": true,\n \"knowledge\": false,\n \"actions\": false,\n \"deploy_phone\": false,\n \"deploy_web\": false\n },\n \"phone_number\": \"+12354635364\",\n \"country_code\": \"CA\",\n \"default_kb_id\": 9,\n \"time_zone\": \"America/Toronto\",\n \"agent_actions\": [],\n \"meta\": {\n \"message\": \"Agent updated successfully.\"\n }\n}"}],"_postman_id":"a128b1cf-47a5-4de1-8f19-f175f4cdb149"},{"name":"index","id":"45e4398b-0237-4195-99ed-ca6ef20a9ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents","description":"This endpoint retrieves a list of agents associated with a specific workspace. It allows users to access detailed information about each agent, including their configuration and operational parameters.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"0b92570c-8f15-4c55-949a-755141519be6","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"1","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"https://api-appstag.kickcall.ai/api/v1/business/workspaces/:workspace_id/agents","protocol":"https","host":["api-appstag","kickcall","ai"],"path":["api","v1","business","workspaces",":workspace_id","agents"],"variable":[{"key":"workspace_id","value":"1","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"a127cb442570082aedc6805854f5f73c\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"db958eb5-e6b6-4b38-8e5d-b6a53bbd6ed4"},{"key":"x-runtime","value":"0.233473"},{"key":"server-timing","value":"sql.active_record;dur=71.49, instantiation.active_record;dur=2.40, start_processing.action_controller;dur=0.01, unpermitted_parameters.action_controller;dur=0.02, render.active_model_serializers;dur=195.30, process_action.action_controller;dur=161.80"},{"key":"Content-Length","value":"35906"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Alex\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": false,\n \"welcome_message\": \"Hi, is this [John]?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 2,\n \"answer_length\": 25,\n \"silence_message_delay\": 25,\n \"silence_end_call\": 25,\n \"concurrent_answer_generation\": 10,\n \"transcribe_filler_words\": false,\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"instructions\": \"# Who You Are\\nYou are [Alex], a professional and proactive Voice AI assistant for [Property Reconnect], specializing in re-engaging dormant real estate leads. Your role is to confidently gather updated information from leads, identify opportunities, and book meetings for a detailed consultation. You maintain a friendly but authoritative tone, ensuring the interaction remains focused and purposeful.\\n\\n# Your Goal for the Call\\nYour primary objective is to reconnect with dormant leads, gather updated information to qualify them, and schedule a meeting to discuss their property needs and opportunities further.\\n\\n# Call Actions\\n## Greeting and Identification\\n### Introduction\\nStart the call by confirming the user's identity in a confident yet approachable tone.\\nSay something like:\\n\\\"Hi, is this [John]?\\\"\\n\\nIf they confirm, proceed with:\\n\\\"Great, this is [Alex] from [Property Reconnect]. I noticed you expressed interest in real estate opportunities a while back, and I'm reaching out to see where you stand and how we can help. Do you have a quick 40 seconds to chat?\\\"\\n\\nIf the user is hesitant or unsure, say something like:\\n\\\"I totally get it...this will just take a moment, and I'll make sure to provide you with the info you need to get back on track with this.\\\"\\n\\nDO NOT proceed without confirming their identity.\\n\\n## Determine Interest in Real Estate Opportunities\\nAsk the user about their current real estate plans directly and confidently.\\nSay something like:\\n\\\"To make the most of our time, could you let me know...are you currently considering buying, selling, or investing in property?\\\"\\n\\nIf the user confirms their interest: Proceed to the step called Assess Real Estate Needs.\\nIf they indicate no interest:\\nSay something like:\\n\\\"Understood! If your plans change in the future, feel free to reach out, and we'll be happy to assist.\\\"\\n\\nDO NOT proceed without confirming their interest level.\\n\\n## Assess Real Estate Needs\\nLet the user share their specific property goals before offering tailored guidance.\\nSay something like:\\n\\\"Tell me more about what you're looking for. Are you thinking about a new home, selling a property, or exploring investment opportunities?\\\"\\n\\n[Record Response as (user_interest)]\\n\\nOnce they answer with what they're looking to do make sure to make them feel good about their decision (use their answer as a reference to get a little more personal as well).\\n\\nDO NOT proceed without gathering this information.\\n\\n## Timeline and Budget\\nAsk targeted questions to confirm their timeline and financial considerations.\\nSay something like:\\n\\\"And when are you hoping to move forward...within the next few months, or later down the line?\\\"\\n\\n[Record Response as (moving_forward_time)]\\n\\nIf buying or investing, ask if they have a general budget or price range in mind for the property you're considering\\n\\n[Record Response as (general_price_range)]\\nIf selling, ask if they've had their property appraised recently to get an idea of its current market value?\\n\\n[Record Response as (property_value)]\\n\\nIf yes or no, acknowledge their response and proceed to the Verify Interest in Appointment Booking step\\nDO NOT proceed without confirming their timeline and financial considerations.\\n\\nVerify Interest in Appointment Booking\\nGather interest in their decisions, use the details you've already gathered from the user and convince them by giving them details about what makes [Our Company] the best.\\n\\nThe goal is to get them to book a discovery call with us.\\n\\nState something that uses the following information they provided from the responses you recorded:\\n\\n(user_interest), (moving_forward_time), (general_price_range), and (property_value)\\n\\nAlways confirm interest in this section, do not proceed to \\\"Verify and Update Contact Information\\\" without the user confirming that they want to schedule with us.\\n\\n(Remember to try to get them interested in booking a meeting with the information above)\\n\\nIf they show interest proceed to the \\\"Verify and Update Contact Information\\\" step\\n\\nVerify and Update Contact Information\\nAsk for the user's best email address in a direct manner to ensure smooth communication.\\nSay something like:\\n\\\"Awesome, well before we move forward with scheduling our call, what's the best email address for us to send over more details?\\\"\\n\\nOnce they provide the email, confirm it back to them.\\nSay something like:\\n\\\"Let me confirm that...did you say [user's email]? Is that correct?\\\"\\n\\nIf the user confirms: Proceed to the step called Appointment Booking.\\nIf they indicate the email is incorrect, politely ask for it again until confirmed.\\n\\nDO NOT proceed without collecting and confirming their email.\\n\\n## Appointment Booking\\nOnce they're ready to book, follow this structured process to confirm the details:\\nAsk for the user's best email if not already provided.\\nSay something like:\\n\\\"Could you confirm the best email for us to send the calendar invite?\\\"\\n\\nIf the user confirms the email: Proceed to gathering their time zone.\\nIf the email is incorrect, politely ask for the correct one until it matches.\\n\\nDO NOT proceed without collecting the user's email.\\n\\nAsk the user for their time zone and explain meeting times are scheduled in EST.\\nSay something like:\\n\\\"Also, could you let me know your time zone so we can coordinate meeting times? We operate in EST, so I'll match the best slots for you.\\\"\\n\\nOnce the time zone is confirmed, offer available times.\\nSay something like:\\n\\\"I have an opening for today at [Available Time 1] or tomorrow at [Available Time 2]. Would either of those work for you?\\\"\\n\\nIf those don't work, ask:\\n\\\"Not a problem...what date and time would be best for you?\\\"\\n\\nCheck their preferred time with the calendar. If it works, proceed; if not, ask for another time until agreed upon.\\n\\nOnce a time is confirmed, say something like:\\n\\\"Perfect. I've got you down for [Scheduled Day and Time]. You'll receive a calendar invite shortly...just accept it when you get it so I know you received it alright?\\\"\\n\\nDO NOT proceed without confirming the meeting time and email.\\n\\nWhen finished, proceed to the step called \\\"Call Ending\\\"\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n## Call Ending\\nWrap up the call professionally and confidently.\\nSay something like:\\n\\\"Thanks so much for taking the time to chat, [John]. We're looking forward to helping you with your real estate goals. If you need anything else, don't hesitate to reach out!\\\"\\n\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n# Knowledge Base\\n## About Us\\n[Property Reconnect is a leading real estate network dedicated to reconnecting clients with tailored property opportunities. Whether buying, selling, or investing, our team ensures a seamless and personalized experience.]\\n\\nBusiness Address - [123 Realty Way, Austin, TX 78702]\\nBusiness Phone - [512-555-4321]\\nBusiness Email - [\\\"contact at propertyreconnect dot com\\\" (C-O-N-T-A-C-T at P-R-O-P-E-R-T-Y-R-E-C-O-N-N-E-C-T dot C-O-M)]\\n## Guardrails and Objection Handling\\n[Responding When Asked If You Are AI:]\\nSay something like:\\n\\\"Yes, I'm an AI assistant, but I'm here to make things as smooth and easy as possible, just like a real person would. Let me know how I can assist!\\\"\\n\\n[Handling Misdialed or Wrong Numbers:]\\nSay something like:\\n\\\"Thanks for letting me know! While I have you, do you know anyone who might be interested in real estate opportunities? I'd love to help!\\\"\\n\\n[If the User Mentions They're Busy:]\\nSay something like:\\n\\\"Totally understand! Would another time work better, or I can send over some info by email for you to review at your convenience?\\\"\\n\\n[Responding to Questions About Source of User's Information:]\\nSay something like:\\n\\\"You expressed interest in real estate opportunities on our platform a while back. I'm following up to see how we can help you today!\\\"\\n\",\n \"physical_location_exists\": null,\n \"location_name\": null,\n \"business_address\": null,\n \"industry\": \"real_estate\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--3c988efe187a21d3798a443645e572357d7800a3/alex\",\n \"agent_token\": \"XXXXXXXX\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"outbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/IftdRlzQy7MP7n3C\",\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"knowledgebasis_ids\": [\n 1\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": true,\n \"knowledge\": false,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 1,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\"\n },\n {\n \"id\": 4,\n \"name\": \"demo agent\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": false,\n \"welcome_message\": null,\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 2,\n \"answer_length\": 25,\n \"silence_message_delay\": 25,\n \"silence_end_call\": 25,\n \"concurrent_answer_generation\": 10,\n \"transcribe_filler_words\": false,\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": null,\n \"background\": null,\n \"instructions\": null,\n \"physical_location_exists\": true,\n \"location_name\": null,\n \"business_address\": null,\n \"industry\": \"healthcare\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": null,\n \"agent_token\": \"yXJGshHHvaanWjbZ\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"inbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/yXJGshHHvuKnWjbZ\",\n \"voice_id\": \"\",\n \"knowledgebasis_ids\": [\n 4\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": false,\n \"knowledge\": true,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 4,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\"\n },\n {\n \"id\": 2,\n \"name\": \"Alex\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": false,\n \"welcome_message\": \"Hi, is this [John]?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 2,\n \"answer_length\": 25,\n \"silence_message_delay\": 25,\n \"silence_end_call\": 25,\n \"concurrent_answer_generation\": 10,\n \"transcribe_filler_words\": false,\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"instructions\": \"# Who You Are\\nYou are [Alex], a professional and proactive Voice AI assistant for [Property Reconnect], specializing in re-engaging dormant real estate leads. Your role is to confidently gather updated information from leads, identify opportunities, and book meetings for a detailed consultation. You maintain a friendly but authoritative tone, ensuring the interaction remains focused and purposeful.\\n\\n# Your Goal for the Call\\nYour primary objective is to reconnect with dormant leads, gather updated information to qualify them, and schedule a meeting to discuss their property needs and opportunities further.\\n\\n# Call Actions\\n## Greeting and Identification\\n### Introduction\\nStart the call by confirming the user's identity in a confident yet approachable tone.\\nSay something like:\\n\\\"Hi, is this [John]?\\\"\\n\\nIf they confirm, proceed with:\\n\\\"Great, this is [Alex] from [Property Reconnect]. I noticed you expressed interest in real estate opportunities a while back, and I'm reaching out to see where you stand and how we can help. Do you have a quick 40 seconds to chat?\\\"\\n\\nIf the user is hesitant or unsure, say something like:\\n\\\"I totally get it...this will just take a moment, and I'll make sure to provide you with the info you need to get back on track with this.\\\"\\n\\nDO NOT proceed without confirming their identity.\\n\\n## Determine Interest in Real Estate Opportunities\\nAsk the user about their current real estate plans directly and confidently.\\nSay something like:\\n\\\"To make the most of our time, could you let me know...are you currently considering buying, selling, or investing in property?\\\"\\n\\nIf the user confirms their interest: Proceed to the step called Assess Real Estate Needs.\\nIf they indicate no interest:\\nSay something like:\\n\\\"Understood! If your plans change in the future, feel free to reach out, and we'll be happy to assist.\\\"\\n\\nDO NOT proceed without confirming their interest level.\\n\\n## Assess Real Estate Needs\\nLet the user share their specific property goals before offering tailored guidance.\\nSay something like:\\n\\\"Tell me more about what you're looking for. Are you thinking about a new home, selling a property, or exploring investment opportunities?\\\"\\n\\n[Record Response as (user_interest)]\\n\\nOnce they answer with what they're looking to do make sure to make them feel good about their decision (use their answer as a reference to get a little more personal as well).\\n\\nDO NOT proceed without gathering this information.\\n\\n## Timeline and Budget\\nAsk targeted questions to confirm their timeline and financial considerations.\\nSay something like:\\n\\\"And when are you hoping to move forward...within the next few months, or later down the line?\\\"\\n\\n[Record Response as (moving_forward_time)]\\n\\nIf buying or investing, ask if they have a general budget or price range in mind for the property you're considering\\n\\n[Record Response as (general_price_range)]\\nIf selling, ask if they've had their property appraised recently to get an idea of its current market value?\\n\\n[Record Response as (property_value)]\\n\\nIf yes or no, acknowledge their response and proceed to the Verify Interest in Appointment Booking step\\nDO NOT proceed without confirming their timeline and financial considerations.\\n\\nVerify Interest in Appointment Booking\\nGather interest in their decisions, use the details you've already gathered from the user and convince them by giving them details about what makes [Our Company] the best.\\n\\nThe goal is to get them to book a discovery call with us.\\n\\nState something that uses the following information they provided from the responses you recorded:\\n\\n(user_interest), (moving_forward_time), (general_price_range), and (property_value)\\n\\nAlways confirm interest in this section, do not proceed to \\\"Verify and Update Contact Information\\\" without the user confirming that they want to schedule with us.\\n\\n(Remember to try to get them interested in booking a meeting with the information above)\\n\\nIf they show interest proceed to the \\\"Verify and Update Contact Information\\\" step\\n\\nVerify and Update Contact Information\\nAsk for the user's best email address in a direct manner to ensure smooth communication.\\nSay something like:\\n\\\"Awesome, well before we move forward with scheduling our call, what's the best email address for us to send over more details?\\\"\\n\\nOnce they provide the email, confirm it back to them.\\nSay something like:\\n\\\"Let me confirm that...did you say [user's email]? Is that correct?\\\"\\n\\nIf the user confirms: Proceed to the step called Appointment Booking.\\nIf they indicate the email is incorrect, politely ask for it again until confirmed.\\n\\nDO NOT proceed without collecting and confirming their email.\\n\\n## Appointment Booking\\nOnce they're ready to book, follow this structured process to confirm the details:\\nAsk for the user's best email if not already provided.\\nSay something like:\\n\\\"Could you confirm the best email for us to send the calendar invite?\\\"\\n\\nIf the user confirms the email: Proceed to gathering their time zone.\\nIf the email is incorrect, politely ask for the correct one until it matches.\\n\\nDO NOT proceed without collecting the user's email.\\n\\nAsk the user for their time zone and explain meeting times are scheduled in EST.\\nSay something like:\\n\\\"Also, could you let me know your time zone so we can coordinate meeting times? We operate in EST, so I'll match the best slots for you.\\\"\\n\\nOnce the time zone is confirmed, offer available times.\\nSay something like:\\n\\\"I have an opening for today at [Available Time 1] or tomorrow at [Available Time 2]. Would either of those work for you?\\\"\\n\\nIf those don't work, ask:\\n\\\"Not a problem...what date and time would be best for you?\\\"\\n\\nCheck their preferred time with the calendar. If it works, proceed; if not, ask for another time until agreed upon.\\n\\nOnce a time is confirmed, say something like:\\n\\\"Perfect. I've got you down for [Scheduled Day and Time]. You'll receive a calendar invite shortly...just accept it when you get it so I know you received it alright?\\\"\\n\\nDO NOT proceed without confirming the meeting time and email.\\n\\nWhen finished, proceed to the step called \\\"Call Ending\\\"\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n## Call Ending\\nWrap up the call professionally and confidently.\\nSay something like:\\n\\\"Thanks so much for taking the time to chat, [John]. We're looking forward to helping you with your real estate goals. If you need anything else, don't hesitate to reach out!\\\"\\n\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n# Knowledge Base\\n## About Us\\n[Property Reconnect is a leading real estate network dedicated to reconnecting clients with tailored property opportunities. Whether buying, selling, or investing, our team ensures a seamless and personalized experience.]\\n\\nBusiness Address - [123 Realty Way, Austin, TX 78702]\\nBusiness Phone - [512-555-4321]\\nBusiness Email - [\\\"contact at propertyreconnect dot com\\\" (C-O-N-T-A-C-T at P-R-O-P-E-R-T-Y-R-E-C-O-N-N-E-C-T dot C-O-M)]\\n## Guardrails and Objection Handling\\n[Responding When Asked If You Are AI:]\\nSay something like:\\n\\\"Yes, I'm an AI assistant, but I'm here to make things as smooth and easy as possible, just like a real person would. Let me know how I can assist!\\\"\\n\\n[Handling Misdialed or Wrong Numbers:]\\nSay something like:\\n\\\"Thanks for letting me know! While I have you, do you know anyone who might be interested in real estate opportunities? I'd love to help!\\\"\\n\\n[If the User Mentions They're Busy:]\\nSay something like:\\n\\\"Totally understand! Would another time work better, or I can send over some info by email for you to review at your convenience?\\\"\\n\\n[Responding to Questions About Source of User's Information:]\\nSay something like:\\n\\\"You expressed interest in real estate opportunities on our platform a while back. I'm following up to see how we can help you today!\\\"\\n\",\n \"physical_location_exists\": null,\n \"location_name\": null,\n \"business_address\": null,\n \"industry\": \"real_estate\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--3c988efe187a21d3798a443645e572357d7800a3/alex\",\n \"agent_token\": \"nnGf4UdF8roucnC4\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"outbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/nnGf4UdF8roucnC4\",\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"knowledgebasis_ids\": [\n 2\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": true,\n \"knowledge\": true,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 2,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\"\n },\n {\n \"id\": 5,\n \"name\": \"demo agent\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": true,\n \"welcome_message\": \"Hello! How can I assist you today?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 3,\n \"answer_length\": 30,\n \"silence_message_delay\": 20,\n \"silence_end_call\": 30,\n \"concurrent_answer_generation\": 5,\n \"transcribe_filler_words\": true,\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": \"Help customers schedule appointments and collect health information.\",\n \"background\": \"Has a background in healthcare communication.\",\n \"instructions\": \"Assist customers in booking appointments and collecting health details.\",\n \"physical_location_exists\": true,\n \"location_name\": \"Health Center\",\n \"business_address\": \"123 Wellness Avenue, Healthcare City\",\n \"industry\": \"technology\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzAsInB1ciI6ImJsb2JfaWQifX0=--d3eaa17a45fb34fcdc2b645e776fe7e921b71026/agent\",\n \"agent_token\": \"1d8mVzvxLaaAisw1\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"inbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/1d8mVzvxLITAisw1\",\n \"voice_id\": \"26\",\n \"knowledgebasis_ids\": [\n 5\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": false,\n \"knowledge\": false,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 5,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\"\n },\n {\n \"id\": 3,\n \"name\": \"Alex\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": false,\n \"welcome_message\": \"Hi, is this [John]?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 2,\n \"answer_length\": 25,\n \"silence_message_delay\": 25,\n \"silence_end_call\": 25,\n \"concurrent_answer_generation\": 10,\n \"transcribe_filler_words\": false,\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"instructions\": \"# Who You Are\\nYou are [Alex], a professional and proactive Voice AI assistant for [Property Reconnect], specializing in re-engaging dormant real estate leads. Your role is to confidently gather updated information from leads, identify opportunities, and book meetings for a detailed consultation. You maintain a friendly but authoritative tone, ensuring the interaction remains focused and purposeful.\\n\\n# Your Goal for the Call\\nYour primary objective is to reconnect with dormant leads, gather updated information to qualify them, and schedule a meeting to discuss their property needs and opportunities further.\\n\\n# Call Actions\\n## Greeting and Identification\\n### Introduction\\nStart the call by confirming the user's identity in a confident yet approachable tone.\\nSay something like:\\n\\\"Hi, is this [John]?\\\"\\n\\nIf they confirm, proceed with:\\n\\\"Great, this is [Alex] from [Property Reconnect]. I noticed you expressed interest in real estate opportunities a while back, and I'm reaching out to see where you stand and how we can help. Do you have a quick 40 seconds to chat?\\\"\\n\\nIf the user is hesitant or unsure, say something like:\\n\\\"I totally get it...this will just take a moment, and I'll make sure to provide you with the info you need to get back on track with this.\\\"\\n\\nDO NOT proceed without confirming their identity.\\n\\n## Determine Interest in Real Estate Opportunities\\nAsk the user about their current real estate plans directly and confidently.\\nSay something like:\\n\\\"To make the most of our time, could you let me know...are you currently considering buying, selling, or investing in property?\\\"\\n\\nIf the user confirms their interest: Proceed to the step called Assess Real Estate Needs.\\nIf they indicate no interest:\\nSay something like:\\n\\\"Understood! If your plans change in the future, feel free to reach out, and we'll be happy to assist.\\\"\\n\\nDO NOT proceed without confirming their interest level.\\n\\n## Assess Real Estate Needs\\nLet the user share their specific property goals before offering tailored guidance.\\nSay something like:\\n\\\"Tell me more about what you're looking for. Are you thinking about a new home, selling a property, or exploring investment opportunities?\\\"\\n\\n[Record Response as (user_interest)]\\n\\nOnce they answer with what they're looking to do make sure to make them feel good about their decision (use their answer as a reference to get a little more personal as well).\\n\\nDO NOT proceed without gathering this information.\\n\\n## Timeline and Budget\\nAsk targeted questions to confirm their timeline and financial considerations.\\nSay something like:\\n\\\"And when are you hoping to move forward...within the next few months, or later down the line?\\\"\\n\\n[Record Response as (moving_forward_time)]\\n\\nIf buying or investing, ask if they have a general budget or price range in mind for the property you're considering\\n\\n[Record Response as (general_price_range)]\\nIf selling, ask if they've had their property appraised recently to get an idea of its current market value?\\n\\n[Record Response as (property_value)]\\n\\nIf yes or no, acknowledge their response and proceed to the Verify Interest in Appointment Booking step\\nDO NOT proceed without confirming their timeline and financial considerations.\\n\\nVerify Interest in Appointment Booking\\nGather interest in their decisions, use the details you've already gathered from the user and convince them by giving them details about what makes [Our Company] the best.\\n\\nThe goal is to get them to book a discovery call with us.\\n\\nState something that uses the following information they provided from the responses you recorded:\\n\\n(user_interest), (moving_forward_time), (general_price_range), and (property_value)\\n\\nAlways confirm interest in this section, do not proceed to \\\"Verify and Update Contact Information\\\" without the user confirming that they want to schedule with us.\\n\\n(Remember to try to get them interested in booking a meeting with the information above)\\n\\nIf they show interest proceed to the \\\"Verify and Update Contact Information\\\" step\\n\\nVerify and Update Contact Information\\nAsk for the user's best email address in a direct manner to ensure smooth communication.\\nSay something like:\\n\\\"Awesome, well before we move forward with scheduling our call, what's the best email address for us to send over more details?\\\"\\n\\nOnce they provide the email, confirm it back to them.\\nSay something like:\\n\\\"Let me confirm that...did you say [user's email]? Is that correct?\\\"\\n\\nIf the user confirms: Proceed to the step called Appointment Booking.\\nIf they indicate the email is incorrect, politely ask for it again until confirmed.\\n\\nDO NOT proceed without collecting and confirming their email.\\n\\n## Appointment Booking\\nOnce they're ready to book, follow this structured process to confirm the details:\\nAsk for the user's best email if not already provided.\\nSay something like:\\n\\\"Could you confirm the best email for us to send the calendar invite?\\\"\\n\\nIf the user confirms the email: Proceed to gathering their time zone.\\nIf the email is incorrect, politely ask for the correct one until it matches.\\n\\nDO NOT proceed without collecting the user's email.\\n\\nAsk the user for their time zone and explain meeting times are scheduled in EST.\\nSay something like:\\n\\\"Also, could you let me know your time zone so we can coordinate meeting times? We operate in EST, so I'll match the best slots for you.\\\"\\n\\nOnce the time zone is confirmed, offer available times.\\nSay something like:\\n\\\"I have an opening for today at [Available Time 1] or tomorrow at [Available Time 2]. Would either of those work for you?\\\"\\n\\nIf those don't work, ask:\\n\\\"Not a problem...what date and time would be best for you?\\\"\\n\\nCheck their preferred time with the calendar. If it works, proceed; if not, ask for another time until agreed upon.\\n\\nOnce a time is confirmed, say something like:\\n\\\"Perfect. I've got you down for [Scheduled Day and Time]. You'll receive a calendar invite shortly...just accept it when you get it so I know you received it alright?\\\"\\n\\nDO NOT proceed without confirming the meeting time and email.\\n\\nWhen finished, proceed to the step called \\\"Call Ending\\\"\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n## Call Ending\\nWrap up the call professionally and confidently.\\nSay something like:\\n\\\"Thanks so much for taking the time to chat, [John]. We're looking forward to helping you with your real estate goals. If you need anything else, don't hesitate to reach out!\\\"\\n\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n# Knowledge Base\\n## About Us\\n[Property Reconnect is a leading real estate network dedicated to reconnecting clients with tailored property opportunities. Whether buying, selling, or investing, our team ensures a seamless and personalized experience.]\\n\\nBusiness Address - [123 Realty Way, Austin, TX 78702]\\nBusiness Phone - [512-555-4321]\\nBusiness Email - [\\\"contact at propertyreconnect dot com\\\" (C-O-N-T-A-C-T at P-R-O-P-E-R-T-Y-R-E-C-O-N-N-E-C-T dot C-O-M)]\\n## Guardrails and Objection Handling\\n[Responding When Asked If You Are AI:]\\nSay something like:\\n\\\"Yes, I'm an AI assistant, but I'm here to make things as smooth and easy as possible, just like a real person would. Let me know how I can assist!\\\"\\n\\n[Handling Misdialed or Wrong Numbers:]\\nSay something like:\\n\\\"Thanks for letting me know! While I have you, do you know anyone who might be interested in real estate opportunities? I'd love to help!\\\"\\n\\n[If the User Mentions They're Busy:]\\nSay something like:\\n\\\"Totally understand! Would another time work better, or I can send over some info by email for you to review at your convenience?\\\"\\n\\n[Responding to Questions About Source of User's Information:]\\nSay something like:\\n\\\"You expressed interest in real estate opportunities on our platform a while back. I'm following up to see how we can help you today!\\\"\\n\",\n \"physical_location_exists\": null,\n \"location_name\": null,\n \"business_address\": null,\n \"industry\": \"real_estate\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--3c988efe187a21d3798a443645e572357d7800a3/alex\",\n \"agent_token\": \"cpPFlGawnWYQT8kx\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"outbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/cpPFlGuynWYQT8kx\",\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"knowledgebasis_ids\": [\n 3\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": true,\n \"knowledge\": true,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 3,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\"\n },\n {\n \"id\": 6,\n \"name\": \"demo agent\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": true,\n \"welcome_message\": \"Hello! How can I assist you today?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 3,\n \"answer_length\": 30,\n \"silence_message_delay\": 20,\n \"silence_end_call\": 30,\n \"concurrent_answer_generation\": 5,\n \"transcribe_filler_words\": true,\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": \"Help customers schedule appointments and collect health information.\",\n \"background\": \"Has a background in healthcare communication.\",\n \"instructions\": \"Assist customers in booking appointments and collecting health details.\",\n \"physical_location_exists\": true,\n \"location_name\": \"Health Center\",\n \"business_address\": \"123 Wellness Avenue, Healthcare City\",\n \"industry\": \"technology\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzEsInB1ciI6ImJsb2JfaWQifX0=--8749844355384b8b29701767229c0a82bc56ad07/agent\",\n \"agent_token\": \"e1tWpXC2B3s5zfyK\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"inbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/e1tWpXC2B3s5zfyK\",\n \"voice_id\": \"1\",\n \"knowledgebasis_ids\": [\n 6\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": false,\n \"knowledge\": false,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 6,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\"\n }\n ],\n \"links\": {\n \"self\": \"http://api-kickcall.lvh.me:3000//api/v1/business/workspaces/1/agents\",\n \"next\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents?page=1\",\n \"prev\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents?page=1\",\n \"last\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents?page=1\",\n \"first\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents?page=1\"\n },\n \"meta\": {\n \"count\": 6,\n \"total_count\": 6,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"45e4398b-0237-4195-99ed-ca6ef20a9ee0"},{"name":"show","id":"c8c55eeb-27c1-4c93-bb19-ff3b8edf93aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:id","description":"This endpoint retrieves specific agent associated with a specific workspace. It allows users to access detailed information about the agent, including their configuration and operational parameters.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent.
\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[{"id":"378f840f-8b25-426f-838f-dbc073086130","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"id","value":"5","description":"Unique identifier for the agent."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"2ecc98c9fc1c6c4eefef9fded022b6c0\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"2b387468-275e-4051-89d4-435d9bd9deec"},{"key":"x-runtime","value":"0.139507"},{"key":"server-timing","value":"sql.active_record;dur=47.48, instantiation.active_record;dur=2.16, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=40.65, process_action.action_controller;dur=57.20"},{"key":"Content-Length","value":"1854"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5,\n \"name\": \"demo agent\",\n \"languages\": [\n \"english\"\n ],\n \"enable_welcome_message\": true,\n \"welcome_message\": \"Hello! How can I assist you today?\",\n \"enable_call_recording\": true,\n \"temperature\": 0.3,\n \"speech_stop_sensitivity\": 3,\n \"answer_length\": 30,\n \"silence_message_delay\": 20,\n \"silence_end_call\": 30,\n \"concurrent_answer_generation\": 5,\n \"transcribe_filler_words\": true,\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": \"Help customers schedule appointments and collect health information.\",\n \"background\": \"Has a background in healthcare communication.\",\n \"instructions\": \"Assist customers in booking appointments and collecting health details.\",\n \"physical_location_exists\": true,\n \"location_name\": \"Health Center\",\n \"business_address\": \"123 Wellness Avenue, Healthcare City\",\n \"industry\": \"technology\",\n \"business_hours\": {\n \"friday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"monday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"sunday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"tuesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"saturday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"thursday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n },\n \"wednesday\": {\n \"open\": true,\n \"to_time\": \"23:59\",\n \"from_time\": \"00:00\"\n }\n },\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzAsInB1ciI6ImJsb2JfaWQifX0=--d3eaa17a45fb34fcdc2b645e776fe7e921b71026/agent\",\n \"agent_token\": \"XXXXXXXX\",\n \"web_embed_configuration\": {},\n \"agent_interaction\": \"inbound\",\n \"personalized_link\": \"http://kickcall.lvh.me:3001/assistant/my-workspace/1d8mVzvxLITAisw1\",\n \"voice_id\": \"26\",\n \"knowledgebasis_ids\": [\n 5\n ],\n \"progress_status\": {\n \"actions\": false,\n \"identity\": false,\n \"knowledge\": false,\n \"deploy_web\": false,\n \"deploy_phone\": false\n },\n \"phone_number\": null,\n \"country_code\": null,\n \"default_kb_id\": 5,\n \"agent_actions\": [],\n \"time_zone\": \"America/Toronto\",\n \"meta\": null\n}"}],"_postman_id":"c8c55eeb-27c1-4c93-bb19-ff3b8edf93aa"},{"name":"delete","id":"941c435d-3837-492c-8c9c-8a8b61402d1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:id","description":"This endpoint deletes a specific agent associated with a specific workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[{"id":"427f9690-f743-4e2c-ba93-eaccbbb4b86e","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":id"],"variable":[{"key":"workspace_id","value":"1"},{"key":"id","value":"6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept"},{"key":"etag","value":"W/\"491bd3b225e9cce837c2c81a885499f2\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"7b395fc6-c072-46d4-9fc7-1d9c90018484"},{"key":"x-runtime","value":"0.088569"},{"key":"server-timing","value":"sql.active_record;dur=13.84, instantiation.active_record;dur=0.38, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.01, transaction.active_record;dur=28.38, render.active_model_serializers;dur=0.05, process_action.action_controller;dur=75.20"},{"key":"Content-Length","value":"49"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Agent destroy Successfully\"\n }\n}"}],"_postman_id":"941c435d-3837-492c-8c9c-8a8b61402d1b"}],"id":"803cbda6-a4f2-46aa-88ef-3af03edf72ec","_postman_id":"803cbda6-a4f2-46aa-88ef-3af03edf72ec","description":""},{"name":"Agent Actions","item":[{"name":"index","id":"19b0e2b4-d743-4932-ad18-789b3bb6bd88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions","description":"This endpoint retrieves a list of agent actions associated with a specific agent within a designated workspace. It provides detailed information about each action, including the action type, details, and the agent's configuration.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"2","key":"agent_id"}]}},"response":[{"id":"eec931e3-3f19-427c-b120-1bb79a542bc9","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","agent_actions"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept"},{"key":"etag","value":"W/\"3439e935e36dc99e9d376cf42fd7729a\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"f853d265-dc9d-4efd-9816-00963afe5859"},{"key":"x-runtime","value":"0.025428"},{"key":"server-timing","value":"sql.active_record;dur=3.20, instantiation.active_record;dur=0.53, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=4.07, process_action.action_controller;dur=19.17"},{"key":"Content-Length","value":"9150"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n },\n {\n \"id\": 3,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n },\n {\n \"id\": 4,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n },\n {\n \"id\": 5,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n },\n {\n \"id\": 8,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n },\n {\n \"id\": 9,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n }\n]"}],"_postman_id":"19b0e2b4-d743-4932-ad18-789b3bb6bd88"},{"name":"Agent Action Types","id":"bc80860b-727e-433b-bc63-8612f06c9c1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/agent_action_types","description":"This endpoint retrieves the available action types for agents within the business. It provides a list of actions that can be performed by agents, which may include sending SMS, transferring calls, writing to worksheets, and other integrations.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions","description":"This endpoint allows you to add a specific action for an agent within a designated workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"4","key":"agent_id"}]}},"response":[{"id":"e1249eb6-d250-47d6-92af-f8b09063dab3","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","agent_actions"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"4","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"bca04d8ff8d1c089d3b90f0737c2f4ea\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"70cc4bce-51f2-4b8f-930b-7dfb7d3313c6"},{"key":"x-runtime","value":"0.085568"},{"key":"server-timing","value":"sql.active_record;dur=37.87, instantiation.active_record;dur=0.64, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.00, transaction.active_record;dur=5.29, render.active_model_serializers;dur=4.50, process_action.action_controller;dur=51.21"},{"key":"Content-Length","value":"1665"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 10,\n \"name\": \"Send SMS to Customer\",\n \"action_type\": \"send_sms\",\n \"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n },\n \"is_ready\": false,\n \"meta\": {\n \"message\": \"Agent Action created successfully.\"\n }\n}"}],"_postman_id":"34f86515-1d55-4ad7-9a94-237a5fb38328"},{"name":"delete","id":"1a10ce5f-603f-4c4c-92f1-8a8c90e10f79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions/:id","description":"This endpoint allows you to delete a specific agent action associated with a given agent in a workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"5","key":"agent_id"},{"description":{"content":"Unique identifier for the agent action
\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[{"id":"575abf22-2e65-4273-ada2-89d7df9d761a","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","agent_actions",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"5","description":"Unique identifier for the agent"},{"key":"id","value":"5","description":"Unique identifier for the agent action"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"10dcb463d831f112f1bb81d8eb1c9656\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"df866503-aa44-4480-b0ba-b5c06012471c"},{"key":"x-runtime","value":"0.155188"},{"key":"server-timing","value":"sql.active_record;dur=44.88, instantiation.active_record;dur=1.32, start_processing.action_controller;dur=0.02, start_transaction.active_record;dur=0.01, transaction.active_record;dur=3.40, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=51.55"},{"key":"Content-Length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Agent Action destroyed successfully.\"\n }\n}"}],"_postman_id":"1a10ce5f-603f-4c4c-92f1-8a8c90e10f79"},{"name":"show","id":"2ef72137-324f-490d-8d4a-334d50fc089d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions/:id","description":"This endpoint retrieves detailed information about a specific agent action associated with an agent in a particular workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"5","key":"agent_id"},{"description":{"content":"Unique identifier for the agent action
\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[{"id":"9528622e-bc37-4087-8819-e1d246c88b36","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","agent_actions",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"5","description":"Unique identifier for the agent"},{"key":"id","value":"2","description":"Unique identifier for the agent action"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"1790cf6e3caba7f547203fa9d02f1ab8\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"79101849-981d-40de-807a-cd8b2c899609"},{"key":"x-runtime","value":"0.146582"},{"key":"server-timing","value":"sql.active_record;dur=11.85, instantiation.active_record;dur=2.62, start_processing.action_controller;dur=0.05, render.active_model_serializers;dur=41.82, process_action.action_controller;dur=63.74"},{"key":"Content-Length","value":"2137"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"name\": \"Transfer call\",\n \"action_type\": \"transfer_call\",\n \"action_details\": {\n \"trigger\": \"Talk to a human or when the user wants to talk with someone else like a manager or the business owner.\",\n \"target_type\": \"phone\",\n \"target_value\": 35,\n \"target_number\": \"+14166706230\",\n \"transfer_mode\": \"warm\"\n },\n \"is_ready\": false,\n \"meta\": null\n}"}],"_postman_id":"2ef72137-324f-490d-8d4a-334d50fc089d"},{"name":"update","id":"cdcc9e70-58b2-4df7-9dae-643eec1db812","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Transfer call\",\n \"action_type\": \"transfer_call\",\n \"action_details\": {\n \"trigger\": \"Talk to a human or when the user wants to talk with someone else like a manager or the business owner.\",\n \"target_number\": \"+14166706230\",\n \"target_type\": \"phone\",\n \"transfer_mode\": \"warm\",\n \"target_value\": 35\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions/:id","description":"This endpoint allows you to update an existing agent action within a specified workspace and agent. You can modify the name, action type, and details associated with the action.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"5","key":"agent_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[{"id":"a22b6170-62b3-46a2-b57b-694f1aa358cd","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Transfer call\",\n \"action_type\": \"transfer_call\",\n \"action_details\": {\n \"trigger\": \"Talk to a human or when the user wants to talk with someone else like a manager or the business owner.\",\n \"target_number\": \"+14166706230\",\n \"target_type\": \"phone\",\n \"transfer_mode\": \"warm\",\n \"target_value\": 35\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/agent_actions/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","agent_actions",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"5","description":"Unique identifier for the agent"},{"key":"id","value":"2","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"9f7fba5dbfa9fbd0502342da9b6826cd\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"3493c4de-aa62-49b5-aecc-2ce446c5fac2"},{"key":"x-runtime","value":"0.118129"},{"key":"server-timing","value":"sql.active_record;dur=26.21, instantiation.active_record;dur=2.14, start_processing.action_controller;dur=0.05, start_transaction.active_record;dur=0.02, transaction.active_record;dur=4.93, render.active_model_serializers;dur=9.56, process_action.action_controller;dur=43.37"},{"key":"Content-Length","value":"2181"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"name\": \"Transfer call\",\n \"action_type\": \"transfer_call\",\n \"action_details\": {\n \"trigger\": \"Talk to a human or when the user wants to talk with someone else like a manager or the business owner.\",\n \"target_number\": \"+14166706230\",\n \"target_type\": \"phone\",\n \"transfer_mode\": \"warm\",\n \"target_value\": 35\n },\n \"is_ready\": false,\n \"meta\": {\n \"message\": \"Agent Action updated successfully.\"\n }\n}"}],"_postman_id":"cdcc9e70-58b2-4df7-9dae-643eec1db812"}],"id":"e52684f6-a630-4e68-bcbe-e5b1c24d233e","description":"The action_details field is a required JSON object whose structure varies based on the action_type. Below is the breakdown of required fields for each type:
\"send_sms\":\"action_details\": {\n \"trigger\": \"when user asks for booking appointment\",\n \"message_content\": \"Here is your link to book an appointment: [link]\"\n}\n\n\"transfer_call\"\"action_details\": {\n \"timeout\": 10,\n \"trigger\": \"when user ask to talk with Support Team or live person\",\n \"target_type\": \"phone\", // or \"extension\"\n \"target_value\": 25, // Operator ID or extension number\n \"transfer_mode\": \"warm\",// Warm or cold\n \"transfer_failure_message\": \"Sorry i couldn't transfer you. Would you like to continue the conversation?\",,\n \"transfer_initiation_message\": \"Let me transfer you to a human. Please hold on.\",\n \"transfer_success_message\": \"I am transferring you now. Goodbye!\",\n \"unavailable_message\": \"Hi! Our team is currently unavailable. For assistance, please call us during our working hours at 9053383107.\",\n \"availability_schedule\": {\n \"monday\": { \"open\": true, \"start_time\": \"10:00\", \"end_time\": \"16:00\" },\n \"tuesday\": { \"open\": false },\n \"wednesday\": { \"open\": true, \"start_time\": \"08:00\", \"end_time\": \"16:00\" },\n \"thursday\": { \"open\": false },\n \"friday\": { \"open\": true, \"start_time\": \"10:00\", \"end_time\": \"18:00\" },\n \"saturday\": { \"open\": true, \"start_time\": \"10:00\", \"end_time\": \"15:00\" },\n \"sunday\": { \"open\": false }\n },\n \"human_availability_enabled\": true\n}\n\n\"custom_api\"\"action_details\": {\n \"trigger\": \"When someone say train details\",\n \"base_url\": \"https://example.com/apis/users\",\n \"http_method\": \"get\",\n \"headers\": [\n {\n \"value\": \"Bearer asgfagjkdsd\",\n \"field_name\": \"Authorization\",\n \"description\": \"The API key used to authenticate the request.\"\n }\n ]\n \"query_params\": [\n {\n \"field_name\": \"number\",\n \"description\": \"please tell me train number\"\n }\n ],\n \"body_params\": [\n {\n \"field_name\": \"number\",\n \"description\": \"please tell me train number\"\n }\n ],\n \"exposed_parameters\": \"name, order_status\"\n}\n\n\"write_to_worksheet\"\"action_details\": {\n \"trigger\": \"When customer ask to leave a note\",\n \"columns\": [\"Name\", \"Email\", \"Phone\", \"Query\", \"Generate Summary\", \"Process\"],\n \"notify_via\": [\"email\", \"sms\"],\n \"worksheet_id\": 77,\n \"target_id\": 25,\n \"agent_response\": \"Let me take the note so that we can get back to you\"\n}\n\n\"integration\"\"action_details\": {\n \"integration_id\": 78\n}\n\nNote:
\ntrigger is common across most action types — it acts as the keyword or phrase that invokes the action.Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks","description":"This endpoint retrieves a list of QA (Question and Answer) chunks associated with a specific agent within a given workspace. It is useful for obtaining relevant question-answer pairs that can be utilized for various purposes, such as training or evaluation.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"5","key":"agent_id"}]}},"response":[{"id":"1733fe3f-862c-48c3-8d31-9cf25cf089de","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"47f77098def8190d67467d58d930d82c\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"74cb8057-4c7d-4c8c-bb70-5afbaa33b6e8"},{"key":"x-runtime","value":"0.176704"},{"key":"server-timing","value":"sql.active_record;dur=4.77, instantiation.active_record;dur=0.73, start_processing.action_controller;dur=0.00, unpermitted_parameters.action_controller;dur=0.05, render.active_model_serializers;dur=0.10, process_action.action_controller;dur=169.36"},{"key":"Content-Length","value":"854"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"chunk_id\": \"5fc5adc28071451628bb52fa0fbf1882\",\n \"create_time\": \"2024-11-26 17:51:30\",\n \"content_with_weight\": \"question: Who is the author of Harry Potter?, answer: The author of Harry Potter is J.K. Rowling.\",\n \"question\": \"Who is the author of Harry Potter?\",\n \"answer\": \"The author of Harry Potter is J.K. Rowling.\"\n }\n ],\n \"links\": {\n \"self\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/qa_chunks\",\n \"next\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/qa_chunks?page=1\",\n \"prev\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/qa_chunks?page=1\",\n \"last\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/qa_chunks?page=1\",\n \"first\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/qa_chunks?page=1\"\n },\n \"meta\": {\n \"count\": 1,\n \"total_count\": 1,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"7aafcfd5-55fd-48ce-b3f0-812f3c015586"},{"name":"create","id":"7641e06a-81fc-4dd4-aeca-c0b6a433bac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chunk\": {\n \"question\": \"Who is the author of Harry Potter?\",\n \"answer\": \"The author of Harry Potter is J.K. Rowling.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks","description":"This endpoint allows users to create or update a QA chunk associated with a specific agent within a designated workspace. A QA chunk consists of a question and its corresponding answer, which can be utilized for various purposes such as enhancing the knowledge base of the agent or improving response accuracy.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"5","key":"agent_id"}]}},"response":[{"id":"e97be5a7-53b1-4c35-9a1d-4a8a9b3088d7","name":"200","originalRequest":{"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chunk\": {\n \"question\": \"Who is the author of Harry Potter?\",\n \"answer\": \"The author of Harry Potter is J.K. Rowling.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"d637d5aa661f6ded46c1826e606c4473\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"f300c212-caa0-457b-bbfb-d9d365aebeb4"},{"key":"x-runtime","value":"1.448073"},{"key":"server-timing","value":"sql.active_record;dur=11.84, instantiation.active_record;dur=0.74, start_processing.action_controller;dur=0.02, render.active_model_serializers;dur=0.36, process_action.action_controller;dur=1392.78"},{"key":"Content-Length","value":"76"}],"cookie":[],"responseTime":null,"body":"{\n \"chunk_id\": \"5fc5adc28071451628bb52fa0fbf1882\",\n \"meta\": {\n \"message\": \"success\"\n }\n}"}],"_postman_id":"7641e06a-81fc-4dd4-aeca-c0b6a433bac9"},{"name":"show","id":"a5e9f6a2-14a0-41d7-9441-68db5e9a09e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/:id","description":"This endpoint retrieves specific QA chunks associated with a particular agent within a workspace. It is designed to allow users to access detailed information about a QA chunk identified by its unique ID.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"},{"description":{"content":"Unique identifier for the qa chucks
\n","type":"text/plain"},"type":"any","value":"5fc5adc28071451628bb52fa0fbf1882","key":"id"}]}},"response":[{"id":"b8d0a9f1-934b-4661-8047-84249872155d","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"5fc5adc28071451628bb52fa0fbf1882"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"8c089a9978eedc1c75541aa1e7c75bf9\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ff4ce4c3-ed75-46ee-8d21-ca27c0bb51f8"},{"key":"x-runtime","value":"0.166463"},{"key":"server-timing","value":"sql.active_record;dur=5.20, instantiation.active_record;dur=0.93, start_processing.action_controller;dur=0.00, render.active_model_serializers;dur=0.09, process_action.action_controller;dur=150.31"},{"key":"Content-Length","value":"308"}],"cookie":[],"responseTime":null,"body":"{\n \"chunk_id\": \"5fc5adc28071451628bb52fa0fbf1882\",\n \"create_time\": \"2024-11-26 17:51:30\",\n \"content_with_weight\": \"question: Who is the author of Harry Potter?, answer: The author of Harry Potter is J.K. Rowling.\",\n \"question\": \"Who is the author of Harry Potter?\",\n \"answer\": \"The author of Harry Potter is J.K. Rowling.\"\n}"}],"_postman_id":"a5e9f6a2-14a0-41d7-9441-68db5e9a09e6"},{"name":"Update","id":"74595b7d-0fc4-4606-b099-dbcc4a7827ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chunk\": {\n \"question\": \"Who is the author of Harry Potter?\",\n \"answer\": \"The author of Harry Potter is J.K. Rowling.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/:id","description":"This endpoint allows you to update an existing QA chunk within a specific agent in a workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"},{"description":{"content":"Unique identifier for the qa chunks
\n","type":"text/plain"},"type":"any","value":"5fc5adc28071451628bb52fa0fbf1882","key":"id"}]}},"response":[{"id":"dd7fee17-f945-4130-88e0-f22821575c42","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chunk\": {\n \"question\": \"Who is the author of Harry Potter?\",\n \"answer\": \"The author of Harry Potter is J.K. Rowling.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"5fc5adc28071451628bb52fa0fbf1882"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"d637d5aa661f6ded46c1826e606c4473\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"b97de61d-fe80-4463-abc4-51f6ea320f81"},{"key":"x-runtime","value":"1.546209"},{"key":"server-timing","value":"sql.active_record;dur=5.30, instantiation.active_record;dur=0.57, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.14, process_action.action_controller;dur=1178.34"},{"key":"Content-Length","value":"76"}],"cookie":[],"responseTime":null,"body":"{\n \"chunk_id\": \"5fc5adc28071451628bb52fa0fbf1882\",\n \"meta\": {\n \"message\": \"success\"\n }\n}"}],"_postman_id":"74595b7d-0fc4-4606-b099-dbcc4a7827ed"},{"name":"Delete","id":"c3d21119-4705-4af2-a830-af86cfef538b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/:id","description":"This endpoint allows you to delete an existing QA chunk within a specific agent in a workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"},{"description":{"content":"Unique identifier for the qa chunks
\n","type":"text/plain"},"type":"any","value":"5fc5adc28071451628bb52fa0fbf1882","key":"id"}]}},"response":[{"id":"d56df382-c68b-4cbe-b94c-58ab0a178bb7","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"5fc5adc28071451628bb52fa0fbf1882"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"9e23f33e7bfcf077f93d7b3638ad41dd\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"046543f7-2646-4fa9-b214-96c31f834715"},{"key":"x-runtime","value":"0.370862"},{"key":"server-timing","value":"sql.active_record;dur=13.93, instantiation.active_record;dur=0.96, start_processing.action_controller;dur=0.02, render.active_model_serializers;dur=0.16, process_action.action_controller;dur=345.93"},{"key":"Content-Length","value":"30"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"success\"\n }\n}"}],"_postman_id":"c3d21119-4705-4af2-a830-af86cfef538b"},{"name":"Export","id":"ad77f454-2c25-4462-9c5f-1b46d9394839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/export","description":"This endpoint allows you to export QA chunks associated with a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"dbf8031d-aca2-4c8e-bfc5-a608e387dc2c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/export","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks","export"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"text/csv"},{"key":"content-disposition","value":"attachment; filename=\"Health Assistant_QA.csv\"; filename*=UTF-8''Health%20Assistant_QA.csv"},{"key":"content-transfer-encoding","value":"binary"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"2ec1ed23084c6d507749beae5b971d80\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ad632bca-1da7-497d-8339-73527eee6f7e"},{"key":"x-runtime","value":"0.341315"},{"key":"server-timing","value":"sql.active_record;dur=7.03, instantiation.active_record;dur=0.89, start_processing.action_controller;dur=0.01, send_data.action_controller;dur=0.52, process_action.action_controller;dur=330.35"},{"key":"Content-Length","value":"186"}],"cookie":[],"responseTime":null,"body":"\"question\",\"answer\"\n\"Who is the author of Harry Potter?\",\"The author of Harry Potter is J.K. Rowling.\"\n\"What is the chemical symbol for water?\",\"The chemical symbol for water is H₂O.\"\n"}],"_postman_id":"ad77f454-2c25-4462-9c5f-1b46d9394839"},{"name":"Import","id":"dd666d0f-8f0c-4378-8232-83642ad301d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/home/karan/Downloads/agent-qa (5).csv"}]},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/import","description":"This endpoint allows you to import QA chunks for a specific agent within a designated workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"4e161133-79f9-4f3d-9c89-b62acc48b60b","name":"200","originalRequest":{"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/home/bikash/Downloads/Untitled spreadsheet - Sheet1.csv"}]},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/qa_chunks/import","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","qa_chunks","import"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"c2c05d76effe079703e69bac0d85848b\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"3dd1df6e-3bed-4db2-bc34-588e459e6567"},{"key":"x-runtime","value":"0.292773"},{"key":"server-timing","value":"sql.active_record;dur=24.19, instantiation.active_record;dur=32.28, start_processing.action_controller;dur=0.01, enqueue.active_job;dur=1.26, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=116.46"},{"key":"Content-Length","value":"51"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Import job has been enqueued\"\n }\n}"}],"_postman_id":"dd666d0f-8f0c-4378-8232-83642ad301d6"}],"id":"da5edcac-313b-47ca-897e-5d8ac713458e","description":"QA Chunks are structured question-answer pairs extracted from knowledge sources to help the agent respond with accurate, context-specific information.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets","description":"This endpoint allows you to retrieve a list of datasets associated with a specific agent within a given workspace.
\nRecord of the particular page
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Number of the records perpage
\n","type":"text/plain"},"key":"per_page","value":"5"},{"disabled":true,"description":{"content":"Returns only the datasets where the datasource_type is set to website (enum value: 1).
\n","type":"text/plain"},"key":"filter[datasource_type_eq]","value":"1"},{"disabled":true,"description":{"content":"Excludes all datasets with datasource_type set to website. Useful when you want to fetch datasets excluding websites.
\n","type":"text/plain"},"key":"filter[datasource_type_not_in][]","value":"1"},{"disabled":true,"description":{"content":"Excludes all datasets where the datasource_type is set to qa (enum value: 8). Helps to filter out question-answer datasets from results.
\n","type":"text/plain"},"key":"filter[datasource_type_not_in][]","value":"8"}],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"}]}},"response":[{"id":"bfbf9144-6527-4f52-9482-02844f82e453","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"5","disabled":true},{"key":"filter[datasource_type_eq]","value":"1","description":"filter for website","disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"5ea0e2567ec25b6bf6f98e03e1efb2d4\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"a62cfa76-208a-456f-ae7b-7697d3f898cb"},{"key":"x-runtime","value":"0.068081"},{"key":"server-timing","value":"sql.active_record;dur=9.55, instantiation.active_record;dur=1.47, start_processing.action_controller;dur=0.02, unpermitted_parameters.action_controller;dur=0.03, render.active_model_serializers;dur=39.47, process_action.action_controller;dur=51.24"},{"key":"Content-Length","value":"2693"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4,\n \"name\": \"demo agent dataset\",\n \"datasource_type\": \"naive\",\n \"file_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjAsInB1ciI6ImJsb2JfaWQifX0=--c0c7d4c7fd1c2ec8bc5242993ba38fe37bb1b2a6/sample.pdf\",\n \"parser_config\": {\n \"raptor\": {\n \"prompt\": \"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\\\n {cluster_content}\\\\nThe above is the content you need to summarize.\",\n \"max_token\": \"256\",\n \"threshold\": \"0.1\",\n \"use_raptor\": \"false\",\n \"max_cluster\": \"64\",\n \"random_seed\": \"21\"\n },\n \"delimiter\": \"\\\\\\\\n!?;。；！？\",\n \"chunk_token_num\": \"128\",\n \"layout_recognize\": \"true\"\n },\n \"status\": \"parsing\",\n \"enable\": true,\n \"progress_message\": \"Task is queued...\",\n \"chunks_count\": 0,\n \"progress\": 0,\n \"created_at\": \"2024-11-26T09:30:09.330Z\"\n },\n {\n \"id\": 3,\n \"name\": \"test name\",\n \"datasource_type\": \"naive\",\n \"file_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTksInB1ciI6ImJsb2JfaWQifX0=--eb622c48e75b74154f98bb17c6a82440ee249a0b/sample.pdf\",\n \"parser_config\": {\n \"raptor\": {\n \"prompt\": \"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\\\n {cluster_content}\\\\nThe above is the content you need to summarize.\",\n \"max_token\": \"256\",\n \"threshold\": \"0.1\",\n \"use_raptor\": \"false\",\n \"max_cluster\": \"64\",\n \"random_seed\": \"21\"\n },\n \"delimiter\": \"\\\\\\\\n!?;。；！？\",\n \"chunk_token_num\": \"158\",\n \"layout_recognize\": \"true\"\n },\n \"status\": \"parsing\",\n \"enable\": true,\n \"progress_message\": \"Task is queued...\",\n \"chunks_count\": 0,\n \"progress\": 0,\n \"created_at\": \"2024-11-26T09:19:29.668Z\"\n },\n {\n \"id\": 1,\n \"name\": \"handbook\",\n \"datasource_type\": \"website\",\n \"file_url\": null,\n \"parser_config\": {\n \"url\": \"https://appstag.kickcall.ai\",\n \"raptor\": {\n \"prompt\": \"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:The above is the content you need to summarize.\",\n \"max_token\": \"256\",\n \"threshold\": \"0.1\",\n \"use_raptor\": \"true\",\n \"max_cluster\": \"64\",\n \"random_seed\": \"21\"\n }\n },\n \"status\": \"parsing\",\n \"enable\": true,\n \"progress_message\": \"Task is queued...\",\n \"chunks_count\": 0,\n \"progress\": 0,\n \"created_at\": \"2024-11-26T08:32:52.489Z\"\n }\n ],\n \"links\": {\n \"self\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/datasets\",\n \"next\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/datasets?page=1\",\n \"prev\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/datasets?page=1\",\n \"last\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/datasets?page=1\",\n \"first\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/agents/1/datasets?page=1\"\n },\n \"meta\": {\n \"count\": 3,\n \"total_count\": 3,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"2bbb0316-7d14-4316-9f3d-ba8e4505abfe"},{"name":"create","id":"62f3ef3d-e6d7-45fd-adb4-863cfb885888","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"dataset[datasource_type]","value":"naive","type":"text"},{"key":"dataset[name]","value":"demo agent dataset","type":"text"},{"key":"dataset[parser_config][chunk_token_num]","value":"128","type":"text"},{"key":"dataset[parser_config][delimiter]","value":"\\\\n!?;。；！？","type":"text"},{"key":"dataset[parser_config][layout_recognize]","value":"true","type":"text"},{"key":"dataset[parser_config][raptor][use_raptor]","value":"false","type":"text"},{"key":"dataset[parser_config][raptor][max_cluster]","value":"64","type":"text"},{"key":"dataset[parser_config][raptor][max_token]","value":"256","type":"text"},{"key":"dataset[parser_config][raptor][prompt]","value":"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\n {cluster_content}\\nThe above is the content you need to summarize.","type":"text"},{"key":"dataset[parser_config][raptor][random_seed]","value":"21","type":"text"},{"key":"dataset[parser_config][raptor][threshold]","value":"0.1","type":"text"},{"key":"documents[]","type":"file","description":"we have support one or more files, import for dateset.
\n","value":null}]},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets","description":"This endpoint allows you to add a dataset to a specific agent within a workspace.
\nThis endpoint is essential for managing datasets associated with agents, enabling users to configure and upload data efficiently.
\n","urlObject":{"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"dc6479bd-75c1-4bd5-a998-495253d2bcff","name":"200","originalRequest":{"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"dataset[datasource_type]","value":"naive","type":"text"},{"key":"dataset[name]","value":"demo agent dataset","type":"text"},{"key":"dataset[parser_config][chunk_token_num]","value":"128","type":"text"},{"key":"dataset[parser_config][delimiter]","value":"\\\\n!?;。；！？","type":"text"},{"key":"dataset[parser_config][layout_recognize]","value":"true","type":"text"},{"key":"dataset[parser_config][raptor][use_raptor]","value":"false","type":"text"},{"key":"dataset[parser_config][raptor][max_cluster]","value":"64","type":"text"},{"key":"dataset[parser_config][raptor][max_token]","value":"256","type":"text"},{"key":"dataset[parser_config][raptor][prompt]","value":"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\n {cluster_content}\\nThe above is the content you need to summarize.","type":"text"},{"key":"dataset[parser_config][raptor][random_seed]","value":"21","type":"text"},{"key":"dataset[parser_config][raptor][threshold]","value":"0.1","type":"text"},{"key":"documents[]","type":"file","src":"/home/karan/Downloads/sample.pdf"}]},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"bc419a8a01e8dab9009425c9a511cc48\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"e045b2e8-0580-4c3b-ab1a-515a7fad2096"},{"key":"x-runtime","value":"0.484003"},{"key":"server-timing","value":"sql.active_record;dur=40.26, instantiation.active_record;dur=1.32, start_processing.action_controller;dur=0.02, start_transaction.active_record;dur=0.03, transaction.active_record;dur=59.36, service_upload.active_storage;dur=7.96, render.active_model_serializers;dur=2.36, process_action.action_controller;dur=464.23"},{"key":"Content-Length","value":"806"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4,\n \"name\": \"demo agent dataset\",\n \"datasource_type\": \"naive\",\n \"file_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjAsInB1ciI6ImJsb2JfaWQifX0=--c0c7d4c7fd1c2ec8bc5242993ba38fe37bb1b2a6/sample.pdf\",\n \"parser_config\": {\n \"chunk_token_num\": \"128\",\n \"delimiter\": \"\\\\\\\\n!?;。；！？\",\n \"layout_recognize\": \"true\",\n \"raptor\": {\n \"use_raptor\": \"false\",\n \"max_cluster\": \"64\",\n \"max_token\": \"256\",\n \"prompt\": \"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\\\n {cluster_content}\\\\nThe above is the content you need to summarize.\",\n \"random_seed\": \"21\",\n \"threshold\": \"0.1\"\n }\n },\n \"status\": \"parsing\",\n \"enable\": true,\n \"progress_message\": \"Task is queued...\",\n \"chunks_count\": 0,\n \"progress\": 0,\n \"created_at\": \"2024-11-26T09:30:09.330Z\"\n }\n]"}],"_postman_id":"62f3ef3d-e6d7-45fd-adb4-863cfb885888"},{"name":"show","id":"93fd3ea5-aeee-499a-9023-cfb1a99d2db5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets/:id","description":"This endpoint retrieves detailed information about a specific dataset associated with a particular agent within a specified workspace.
\nThis structured response provides comprehensive details about the dataset, including its configuration and processing status, which can be useful for further analysis or integration.
\n","urlObject":{"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"},{"description":{"content":"Unique identifier for the dataset
\n","type":"text/plain"},"type":"any","value":"3","key":"id"}]}},"response":[{"id":"59ca64b3-9985-4ba0-8c3f-47f84df4a611","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"4115e6b4e1b5e189b056de7882615708\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"3147ad68-4187-408e-b9b9-d26b668fbce4"},{"key":"x-runtime","value":"0.034942"},{"key":"server-timing","value":"sql.active_record;dur=5.99, instantiation.active_record;dur=0.98, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=8.81, process_action.action_controller;dur=26.74"},{"key":"Content-Length","value":"807"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"name\": \"test name\",\n \"datasource_type\": \"naive\",\n \"file_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTksInB1ciI6ImJsb2JfaWQifX0=--eb622c48e75b74154f98bb17c6a82440ee249a0b/sample.pdf\",\n \"parser_config\": {\n \"raptor\": {\n \"prompt\": \"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\\\n {cluster_content}\\\\nThe above is the content you need to summarize.\",\n \"max_token\": \"256\",\n \"threshold\": \"0.1\",\n \"use_raptor\": \"false\",\n \"max_cluster\": \"64\",\n \"random_seed\": \"21\"\n },\n \"delimiter\": \"\\\\\\\\n!?;。；！？\",\n \"chunk_token_num\": \"158\",\n \"layout_recognize\": \"true\"\n },\n \"status\": \"parsing\",\n \"enable\": true,\n \"progress_message\": \"Task is queued...\",\n \"chunks_count\": 0,\n \"progress\": 0,\n \"created_at\": \"2024-11-26T09:19:29.668Z\",\n \"meta\": null\n}"}],"_postman_id":"93fd3ea5-aeee-499a-9023-cfb1a99d2db5"},{"name":"Update","id":"8b33fe8c-64c7-4fb9-84fb-ad24c6f28ff5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"dataset[datasource_type]","value":"naive","type":"text"},{"key":"dataset[name]","value":"update","type":"text"},{"key":"dataset[parser_config][chunk_token_num]","value":"128","type":"text"},{"key":"dataset[parser_config][delimiter]","value":"\\\\n!?;。；！？","type":"text"},{"key":"dataset[parser_config][layout_recognize]","value":"true","type":"text"},{"key":"dataset[parser_config][raptor][use_raptor]","value":"false","type":"text"},{"key":"dataset[parser_config][raptor][max_cluster]","value":"64","type":"text"},{"key":"dataset[parser_config][raptor][max_token]","value":"256","type":"text"},{"key":"dataset[parser_config][raptor][prompt]","value":"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\n {cluster_content}\\nThe above is the content you need to summarize.","type":"text"},{"key":"dataset[parser_config][raptor][random_seed]","value":"21","type":"text"},{"key":"dataset[parser_config][raptor][threshold]","value":"0.1","type":"text"}]},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets/:id","description":"This endpoint allows you to update an existing dataset associated with a specific agent in a workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"},{"description":{"content":"Unique identifier for the dataset
\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[{"id":"3c7c5d08-0a1b-4931-ac44-05a2c49fc986","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"dataset[datasource_type]","value":"naive","type":"text"},{"key":"dataset[name]","value":"update","type":"text"},{"key":"dataset[parser_config][chunk_token_num]","value":"128","type":"text"},{"key":"dataset[parser_config][delimiter]","value":"\\\\n!?;。；！？","type":"text"},{"key":"dataset[parser_config][layout_recognize]","value":"true","type":"text"},{"key":"dataset[parser_config][raptor][use_raptor]","value":"false","type":"text"},{"key":"dataset[parser_config][raptor][max_cluster]","value":"64","type":"text"},{"key":"dataset[parser_config][raptor][max_token]","value":"256","type":"text"},{"key":"dataset[parser_config][raptor][prompt]","value":"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\n {cluster_content}\\nThe above is the content you need to summarize.","type":"text"},{"key":"dataset[parser_config][raptor][random_seed]","value":"21","type":"text"},{"key":"dataset[parser_config][raptor][threshold]","value":"0.1","type":"text"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"5a5d335f5205592bf6a020fe6d0212de\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"75cb699e-931c-4ad7-b8d8-45edd207956c"},{"key":"x-runtime","value":"0.041867"},{"key":"server-timing","value":"sql.active_record;dur=16.55, instantiation.active_record;dur=0.90, start_processing.action_controller;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=11.64, render.active_model_serializers;dur=6.67, process_action.action_controller;dur=35.57"},{"key":"Content-Length","value":"843"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"name\": \"update\",\n \"datasource_type\": \"naive\",\n \"file_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjAsInB1ciI6ImJsb2JfaWQifX0=--c0c7d4c7fd1c2ec8bc5242993ba38fe37bb1b2a6/sample.pdf\",\n \"parser_config\": {\n \"chunk_token_num\": \"128\",\n \"delimiter\": \"\\\\\\\\n!?;。；！？\",\n \"layout_recognize\": \"true\",\n \"raptor\": {\n \"use_raptor\": \"false\",\n \"max_cluster\": \"64\",\n \"max_token\": \"256\",\n \"prompt\": \"Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:\\\\n {cluster_content}\\\\nThe above is the content you need to summarize.\",\n \"random_seed\": \"21\",\n \"threshold\": \"0.1\"\n }\n },\n \"status\": \"parsing\",\n \"enable\": true,\n \"progress_message\": \"Task is queued...\",\n \"chunks_count\": 0,\n \"progress\": 0,\n \"created_at\": \"2024-11-26T09:30:09.330Z\",\n \"meta\": {\n \"message\": \"Dataset updated successfully.\"\n }\n}"}],"_postman_id":"8b33fe8c-64c7-4fb9-84fb-ad24c6f28ff5"},{"name":"Delete","id":"ce06bc86-0268-4f73-9c12-96eaefa57554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets/:id","description":"This endpoint is used to delete a specific dataset associated with a particular agent within a workspace. By sending a DELETE request to this endpoint, users can remove datasets that are no longer needed, helping to maintain an organized and efficient workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"},{"description":{"content":"Unique identifier for the dataset
\n","type":"text/plain"},"type":"any","value":"3","key":"id"}]}},"response":[{"id":"9b6d4965-b246-4064-b9e0-2161523c2407","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/datasets/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","datasets",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"93b1df53b99f4c9b2d9f06cdb04dff87\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"455add6f-b83c-4def-b259-f27589006d8e"},{"key":"x-runtime","value":"0.056137"},{"key":"server-timing","value":"sql.active_record;dur=7.04, instantiation.active_record;dur=0.63, start_processing.action_controller;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=8.72, enqueue.active_job;dur=15.14, render.active_model_serializers;dur=0.07, process_action.action_controller;dur=50.61"},{"key":"Content-Length","value":"54"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Dataset destroyed successfully.\"\n }\n}"}],"_postman_id":"ce06bc86-0268-4f73-9c12-96eaefa57554"}],"id":"9b004353-d3f1-4dca-aaa9-495060148048","description":"A Dataset represents a curated collection of domain-specific content that is processed and converted into QA Chunks for use in an agent's knowledgebase. These datasets are the raw materials used to train or guide an agent’s understanding and responses in a given subject area.
\nA Knowledgebase is a structured information that an agent can access and use during conversations. It may include FAQs, website scrape, and different types of documents, that help the agent respond accurately and effectively.
\nAgents rely on the knowledgebase to:
\nRetrieve factual answers
\nGenerate context-aware responses
\nSupport domain-specific tasks (e.g., healthcare, real estate, education)
\nThis endpoint retrieves a list of voice configurations associated with a specific agent in a particular workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"2d7389c5-0baf-4406-87de-3f5214d9dcfd","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"1","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/1/voices","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents","1","voices"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"ee38f28ab8977596206c5f6c8cfc1142\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"b1b948bf-3183-4afb-90ce-f812e47623d0"},{"key":"x-runtime","value":"11.557333"},{"key":"server-timing","value":"sql.active_record;dur=79.84, instantiation.active_record;dur=99.03, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=56.88, process_action.action_controller;dur=11314.01"},{"key":"Content-Length","value":"4295"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"voice_id\": \"9BWtsMINqrJLrRacOk9x\",\n \"friendly_name\": \"Aria - Female, Multilingual\",\n \"audio_url\": \"/voices/9BWtsMINqrJLrRacOk9x.mp3\"\n },\n {\n \"voice_id\": \"CwhRBWXzGAHq8TQ4Fs17\",\n \"friendly_name\": \"Roger - Male, Multilingual\",\n \"audio_url\": \"/voices/CwhRBWXzGAHq8TQ4Fs17.mp3\"\n },\n {\n \"voice_id\": \"EXAVITQu4vr4xnSDxMaL\",\n \"friendly_name\": \"Sarah - Female, Multilingual\",\n \"audio_url\": \"/voices/EXAVITQu4vr4xnSDxMaL.mp3\"\n },\n {\n \"voice_id\": \"FGY2WhTYpPnrIDTdsKH5\",\n \"friendly_name\": \"Laura - Female, Multilingual\",\n \"audio_url\": \"/voices/FGY2WhTYpPnrIDTdsKH5.mp3\"\n },\n {\n \"voice_id\": \"IKne3meq5aSn9XLyUdCD\",\n \"friendly_name\": \"Charlie - Male, Multilingual\",\n \"audio_url\": \"/voices/IKne3meq5aSn9XLyUdCD.mp3\"\n },\n {\n \"voice_id\": \"JBFqnCBsd6RMkjVDRZzb\",\n \"friendly_name\": \"George - Male, Multilingual\",\n \"audio_url\": \"/voices/JBFqnCBsd6RMkjVDRZzb.mp3\"\n },\n {\n \"voice_id\": \"N2lVS1w4EtoT3dr4eOWO\",\n \"friendly_name\": \"Callum - Male, Multilingual\",\n \"audio_url\": \"/voices/N2lVS1w4EtoT3dr4eOWO.mp3\"\n },\n {\n \"voice_id\": \"SAz9YHcvj6GT2YYXdXww\",\n \"friendly_name\": \"River - Female, Multilingual\",\n \"audio_url\": \"/voices/SAz9YHcvj6GT2YYXdXww.mp3\"\n },\n {\n \"voice_id\": \"TX3LPaxmHKxFdv7VOQHJ\",\n \"friendly_name\": \"Liam - Male, Multilingual\",\n \"audio_url\": \"/voices/TX3LPaxmHKxFdv7VOQHJ.mp3\"\n },\n {\n \"voice_id\": \"XB0fDUnXU5powFXDhCwa\",\n \"friendly_name\": \"Charlotte - Female, Multilingual\",\n \"audio_url\": \"/voices/XB0fDUnXU5powFXDhCwa.mp3\"\n },\n {\n \"voice_id\": \"Xb7hH8MSUJpSbSDYk0k2\",\n \"friendly_name\": \"Alice - Female, Multilingual\",\n \"audio_url\": \"/voices/Xb7hH8MSUJpSbSDYk0k2.mp3\"\n },\n {\n \"voice_id\": \"XrExE9yKIg1WjnnlVkGX\",\n \"friendly_name\": \"Matilda - Female, Multilingual\",\n \"audio_url\": \"/voices/XrExE9yKIg1WjnnlVkGX.mp3\"\n },\n {\n \"voice_id\": \"bIHbv24MWmeRgasZH58o\",\n \"friendly_name\": \"Will - Male, Multilingual\",\n \"audio_url\": \"/voices/bIHbv24MWmeRgasZH58o.mp3\"\n },\n {\n \"voice_id\": \"cgSgspJ2msm6clMCkdW9\",\n \"friendly_name\": \"Jessica - Female, Multilingual\",\n \"audio_url\": \"/voices/cgSgspJ2msm6clMCkdW9.mp3\"\n },\n {\n \"voice_id\": \"cjVigY5qzO86Huf0OWal\",\n \"friendly_name\": \"Eric - Male, Multilingual\",\n \"audio_url\": \"/voices/cjVigY5qzO86Huf0OWal.mp3\"\n },\n {\n \"voice_id\": \"iP95p4xoKVk53GoZ742B\",\n \"friendly_name\": \"Chris - Male, Multilingual\",\n \"audio_url\": \"/voices/iP95p4xoKVk53GoZ742B.mp3\"\n },\n {\n \"voice_id\": \"nPczCjzI2devNBz1zQrb\",\n \"friendly_name\": \"Brian - Male, Multilingual\",\n \"audio_url\": \"/voices/nPczCjzI2devNBz1zQrb.mp3\"\n },\n {\n \"voice_id\": \"onwK4e9ZLuTAKqWW03F9\",\n \"friendly_name\": \"Daniel - Male, Multilingual\",\n \"audio_url\": \"/voices/onwK4e9ZLuTAKqWW03F9.mp3\"\n },\n {\n \"voice_id\": \"pFZP5JQG7iQjIQuC4Bku\",\n \"friendly_name\": \"Lily - Female, Multilingual\",\n \"audio_url\": \"/voices/pFZP5JQG7iQjIQuC4Bku.mp3\"\n },\n {\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"friendly_name\": \"Bill - Male, Multilingual\",\n \"audio_url\": \"/voices/pqHfZKP75CvOlQylNhV4.mp3\"\n },\n {\n \"voice_id\": \"21m00Tcm4TlvDq8ikWAM\",\n \"friendly_name\": \"Rachel - Female, Multilingual\",\n \"audio_url\": \"/voices/21m00Tcm4TlvDq8ikWAM.mp3\"\n },\n {\n \"voice_id\": \"29vD33N1CtxCmqQRPOHJ\",\n \"friendly_name\": \"Drew - Male, Multilingual\",\n \"audio_url\": \"/voices/29vD33N1CtxCmqQRPOHJ.mp3\"\n },\n {\n \"voice_id\": \"2EiwWnXFnvU5JabPnv8n\",\n \"friendly_name\": \"Clyde - Male, Multilingual\",\n \"audio_url\": \"/voices/2EiwWnXFnvU5JabPnv8n.mp3\"\n },\n {\n \"voice_id\": \"5Q0t7uMcjvnagumLfvZi\",\n \"friendly_name\": \"Paul - Male, Multilingual\",\n \"audio_url\": \"/voices/5Q0t7uMcjvnagumLfvZi.mp3\"\n },\n {\n \"voice_id\": \"AZnzlk1XvdvUeBnXmlld\",\n \"friendly_name\": \"Domi - Female, Multilingual\",\n \"audio_url\": \"/voices/AZnzlk1XvdvUeBnXmlld.mp3\"\n },\n {\n \"voice_id\": \"CYw3kZ02Hs0563khs1Fj\",\n \"friendly_name\": \"Dave - Male, Multilingual\",\n \"audio_url\": \"/voices/CYw3kZ02Hs0563khs1Fj.mp3\"\n },\n {\n \"voice_id\": \"D38z5RcWu1voky8WS1ja\",\n \"friendly_name\": \"Fin - Male, Multilingual\",\n \"audio_url\": \"/voices/D38z5RcWu1voky8WS1ja.mp3\"\n },\n {\n \"voice_id\": \"IKne3meq5aSn9XLyUdCD\",\n \"friendly_name\": \"Charlie - Male, Multilingual\",\n \"audio_url\": \"/voices/IKne3meq5aSn9XLyUdCD.mp3\"\n },\n {\n \"voice_id\": \"JBFqnCBsd6RMkjVDRZzb\",\n \"friendly_name\": \"George - Male, Multilingual\",\n \"audio_url\": \"/voices/JBFqnCBsd6RMkjVDRZzb.mp3\"\n },\n {\n \"voice_id\": \"LcfcDJNUP1GQjkzn1xUU\",\n \"friendly_name\": \"Emily - Female, Multilingual\",\n \"audio_url\": \"/voices/LcfcDJNUP1GQjkzn1xUU.mp3\"\n },\n {\n \"voice_id\": \"MF3mGyEYCl7XYWbV9V6O\",\n \"friendly_name\": \"Elli - Female, Multilingual\",\n \"audio_url\": \"/voices/MF3mGyEYCl7XYWbV9V6O.mp3\"\n },\n {\n \"voice_id\": \"N2lVS1w4EtoT3dr4eOWO\",\n \"friendly_name\": \"Callum - Male, Multilingual\",\n \"audio_url\": \"/voices/N2lVS1w4EtoT3dr4eOWO.mp3\"\n },\n {\n \"voice_id\": \"ODq5zmih8GrVes37Dizd\",\n \"friendly_name\": \"Patrick - Male, Multilingual\",\n \"audio_url\": \"/voices/ODq5zmih8GrVes37Dizd.mp3\"\n }\n ],\n \"meta\": {\n \"clone_voice\": true\n }\n}"}],"_postman_id":"059277a7-8f3f-404f-86d8-3ae7391e47a7"}],"id":"522bd6c6-9a12-47c4-985d-a16f3aa14afc","description":"Voices represent the available voice profiles that can be assigned to agents for text-to-speech (TTS) responses. These voices define how the agent sounds — including aspects like accent, tone, and style — enabling a more human-like and personalized interaction experience.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/languages","description":"This endpoint retrieves the list of languages supported by a specific agent within a workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"}]}},"response":[{"id":"b0192e18-ff68-4df5-98f9-c2ff552af0f4","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/languages","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","languages"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"171","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 27 Jun 2025 13:17:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"f340b007299778ecfb3f060321f87957\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"fad58444-10c1-4d45-9a5a-4e57510b13f0"},{"key":"x-runtime","value":"0.019956"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n \"english\"\n ]\n}"}],"_postman_id":"7d0fdd95-f592-444c-b1e9-83d0dd555280"}],"id":"f7944b7f-3c0a-406a-a568-560a349b062d","description":"Specifies the languages an agent can understand and respond in during conversations. This capability ensures the agent can engage users in their preferred language, both in text and speech formats.
\nFor example, if an agent supports English and Spanish, it can detect questions in either language and reply accordingly.
\n","_postman_id":"f7944b7f-3c0a-406a-a568-560a349b062d"},{"name":"Interactions","item":[{"name":"index","id":"f2809252-64c9-4970-a882-861cfd9087ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/interactions","description":"This endpoint allows you to retrieve interactions associated with a specific agent within a designated workspace. The interactions can be filtered based on the source type and additional source information.
\nInteraction can be from 3 sources i.e sms, web, phone
\n","type":"text/plain"},"key":"filter[source_eq]","value":"sms"},{"disabled":true,"key":"source_info_cont","value":"2345678"},{"disabled":true,"key":"contact_id_eq","value":"1"}],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"}]}},"response":[{"id":"e6c5b259-9678-43ec-bdc2-e22c74883e0c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/interactions","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","interactions"],"query":[{"key":"calls_received_in","value":"2025-02-01,2025-02-28","disabled":true},{"key":"filter[source_eq]","value":"sms","description":"Interaction can be from 3 sources i.e sms, web, phone","disabled":true},{"key":"source_info_cont","value":"2345678","disabled":true},{"key":"contact_id_eq","value":"1","disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"171","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 27 Jun 2025 13:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"17201"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"fbb08ae888003585c92a2ed425155943\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"f5b16484-1bde-48e7-b6dc-9af790327ed8"},{"key":"x-runtime","value":"0.090529"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 2937,\n \"source_type\": \"phone\",\n \"source_info\": \"+18674652865\",\n \"details\": {\n \"duration\": \"0:32\",\n \"start_at\": \"2025-06-27 11:36:14\",\n \"to_phone\": \"+15878573890\",\n \"web_uuid\": null,\n \"from_phone\": \"+18674652865\"\n },\n \"recording_url\": null,\n \"interaction_journey\": [\n {\n \"role\": \"assistant\",\n \"content\": \"\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Thanks for trying our documentation.\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Enjoy.\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"Thank you! If you have any questions or need assistance feel free to ask. I'm here to help!\"\n }\n ],\n \"agent_id\": 171,\n \"contact_id\": 596,\n \"created_at\": \"2025-06-27T14:36:46.303+03:00\",\n \"updated_at\": \"2025-06-27T14:36:46.410+03:00\",\n \"summary\": \"The user thanked the assistant for the documentation and expressed enjoyment, while the assistant offered further assistance if needed.\",\n \"direction\": \"outbound\",\n \"test\": false,\n \"start_at\": \"2025-06-27T14:36:14.000+03:00\"\n },\n {\n \"id\": 2936,\n \"source_type\": \"phone\",\n \"source_info\": \"+19977548592\",\n \"details\": {\n \"duration\": \"0:13\",\n \"start_at\": \"2025-06-27 11:33:57\",\n \"to_phone\": \"+15878573890\",\n \"web_uuid\": null,\n \"from_phone\": \"+19977548592\"\n },\n \"recording_url\": null,\n \"interaction_journey\": [\n {\n \"role\": \"assistant\",\n \"content\": \"Hey, how can I help you today?\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Hey. How are you?\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"I'm doing great thank you for\"\n }\n ],\n \"agent_id\": 171,\n \"contact_id\": 598,\n \"created_at\": \"2025-06-27T14:34:10.100+03:00\",\n \"updated_at\": \"2025-06-27T14:34:10.192+03:00\",\n \"summary\": \"The user greeted the assistant and inquired about their well-being, to which the assistant responded positively.\",\n \"direction\": \"inbound\",\n \"test\": false,\n \"start_at\": \"2025-06-27T14:33:57.000+03:00\"\n }\n ],\n \"links\": {\n \"self\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/agents/171/interactions\",\n \"next\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/agents/171/interactions?page=2\",\n \"prev\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/agents/171/interactions?page=1\",\n \"last\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/agents/171/interactions?page=15\",\n \"first\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/agents/171/interactions?page=1\"\n },\n \"meta\": {\n \"count\": 20,\n \"total_count\": 286,\n \"total_pages\": 15\n }\n}"}],"_postman_id":"f2809252-64c9-4970-a882-861cfd9087ae"},{"name":"delete","id":"3a9637db-dcdb-40f6-9f6a-7fa31a96d736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/interactions/:id","description":"This endpoint allows you to delete a specific interaction associated with an agent in a particular workspace.
\nEnsure that the specified workspace_id, agent_id, and id are valid and correspond to existing records in the system.
Deleting an interaction is irreversible, so please confirm that you wish to proceed with this action.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"2","key":"agent_id"},{"description":{"content":"Unique identifier for the interaction
\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[{"id":"4dfa04d6-17c0-42bc-8c3d-b07703ed1769","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/interactions/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","interactions",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"},{"key":"agent_id","value":"1"},{"key":"id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"4a042979ca8dbb68007b76531b740c4b\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"069ad70f-2123-40f6-9ff7-93f9faa1ecb4"},{"key":"x-runtime","value":"0.101289"},{"key":"server-timing","value":"sql.active_record;dur=11.86, instantiation.active_record;dur=0.62, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.00, transaction.active_record;dur=12.93, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=86.23"},{"key":"Content-Length","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Interaction destroyed successfully.\"\n }\n}"}],"_postman_id":"3a9637db-dcdb-40f6-9f6a-7fa31a96d736"},{"name":"show","id":"9839183d-e0e8-4bc3-8e76-1693ee2a5bc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/interactions/:id","description":"This endpoint retrieves details about a specific interaction associated with a particular agent in a specified workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"},{"description":{"content":"Unique identifier for the interaction
\n","type":"text/plain"},"type":"any","value":"2937","key":"id"}]}},"response":[{"id":"94cf156c-9129-4fb0-8023-df4173d4b25a","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/interactions/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","interactions",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"171","description":"Unique identifier for the agent"},{"key":"id","value":"2937","description":"Unique identifier for the interaction"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 27 Jun 2025 13:22:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"894"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"a174f18059b14179adfdfd5ae47c3728\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"89f974f3-5e1c-4704-af98-ab9e5c9debca"},{"key":"x-runtime","value":"0.021555"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2937,\n \"source_type\": \"phone\",\n \"source_info\": \"+18674652865\",\n \"details\": {\n \"duration\": \"0:32\",\n \"start_at\": \"2025-06-27 11:36:14\",\n \"to_phone\": \"+15878573890\",\n \"web_uuid\": null,\n \"from_phone\": \"+18674652865\"\n },\n \"recording_url\": null,\n \"interaction_journey\": [\n {\n \"role\": \"assistant\",\n \"content\": \"\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Thanks for trying our documentation.\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Enjoy.\"\n },\n {\n \"role\": \"assistant\",\n \"content\": \"Thank you! If you have any questions or need assistance feel free to ask. I'm here to help!\"\n }\n ],\n \"agent_id\": 171,\n \"contact_id\": 596,\n \"created_at\": \"2025-06-27T14:36:46.303+03:00\",\n \"updated_at\": \"2025-06-27T14:36:46.410+03:00\",\n \"summary\": \"The user thanked the assistant for the documentation and expressed enjoyment, while the assistant offered further assistance if needed.\",\n \"direction\": \"outbound\",\n \"test\": false,\n \"start_at\": \"2025-06-27T14:36:14.000+03:00\",\n \"meta\": null\n}"}],"_postman_id":"9839183d-e0e8-4bc3-8e76-1693ee2a5bc9"}],"id":"3473bd7f-c87e-48ff-95ff-b9ae51dc749b","description":"An interaction represents a single conversational session or communication event between an agent and a user (contact). This record captures the full lifecycle of the dialogue, including its context, metadata, and processing details.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to_number\": \"+917389058485\",\n \"test\": true,\n \"welcome_message\": \"\",\n \"custom_variables\": [\n {\n \"key\": \"Company\",\n \"value\": \"abc\"\n },\n {\n \"key\": \"Role\",\n \"value\": \"Sales Specialist\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_call","description":"This endpoint is used to initiate an outbound voice call from an agent to a specified phone number. This allows agents or automated systems to proactively reach out to users.
\nIt enables real-time voice communication by triggering a call session programmatically.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"327","key":"agent_id"}]}},"response":[{"id":"a4080e1f-1740-4fdc-b439-04e7aa4a6120","name":"200","originalRequest":{"method":"POST","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to_number\": \"+15353258485\",\n \"test\": true,\n \"custom_variables\": [\n {\n \"key\": \"Company\",\n \"value\": \"abc\"\n },\n {\n \"key\": \"Role\",\n \"value\": \"Sales Specialist\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_call","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","outbound_call"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"69a9efbb636b353c0e5d14e6ef2adfac\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"616bc66f-6a1a-4d21-b8da-f9154c27fea2"},{"key":"x-runtime","value":"16.058588"},{"key":"server-timing","value":"sql.active_record;dur=101.88, instantiation.active_record;dur=66.52, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=15763.19"},{"key":"Content-Length","value":"50"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Call initiated successfully\"\n }\n}"}],"_postman_id":"f4211843-103f-444a-9567-1bd32b896696"}],"id":"3543ded0-2833-46bf-b720-aa720d50d8cf","_postman_id":"3543ded0-2833-46bf-b720-aa720d50d8cf","description":""},{"name":"SIP Trunks","item":[{"name":"Inbound","item":[{"name":"create","id":"9d9b7a0a-9da9-4dd4-9b06-10a7ca6f3ceb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"name\": \"AB my inbound\",\n \"numbers\": [\"+15878573893\"],\n \"allowed_addresses\": [\"192.168.1.0/24\", \"10.0.0.1\"],\n \"allowed_numbers\": [\"+15878573891\"],\n \"auth_username\": \"sipuser123\",\n \"auth_password\": \"supersecurepassword\",\n \"ringing_timeout\": \"10s\",\n \"max_call_duration\": \"30s\",\n \"media_encryption\": 0,\n \"provider\": \"twilio\"\n }\n}\n"},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","description":"This endpoint allows users to create a new Inbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"c0480530-6c83-4ade-bf9d-e8ce3e824054","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"name\": \"AB my inbound\",\n \"numbers\": [\"+15878573890\"],\n \"allowed_addresses\": [\"192.168.1.0/24\", \"10.0.0.1\"],\n \"allowed_numbers\": [\"+15878573890\"],\n \"auth_username\": \"sipuser123\",\n \"auth_password\": \"supersecurepassword\",\n \"ringing_timeout\": \"10s\",\n \"max_call_duration\": \"30s\",\n \"media_encryption\": 0,\n \"provider\": \"twilio\"\n }\n}\n"},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","inbound_sip_trunk"],"query":[{"key":"","value":null,"disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"ed31172bc3981fe83d01f2d60047da52\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"9e135e3f-4ea3-48de-9005-f49cc7a2507e"},{"key":"x-runtime","value":"4.086450"},{"key":"server-timing","value":"sql.active_record;dur=9.67, instantiation.active_record;dur=0.44, start_processing.action_controller;dur=0.00, unpermitted_parameters.action_controller;dur=0.01, start_transaction.active_record;dur=0.02, transaction.active_record;dur=2158.33, render.active_model_serializers;dur=1.03, process_action.action_controller;dur=4048.37"},{"key":"Content-Length","value":"564"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 52,\n \"name\": \"AB my inbound\",\n \"sip_trunk_id\": \"ST_9s3VMHQNcJhg\",\n \"provider\": \"twilio\",\n \"additional_config\": {},\n \"numbers\": [\n \"+15878573890\"\n ],\n \"allowed_addresses\": [\n \"192.168.1.0/24\",\n \"10.0.0.1\"\n ],\n \"allowed_numbers\": [\n \"+15878573890\"\n ],\n \"auth_username\": \"sipuser123\",\n \"auth_password\": \"supersecurepassword\",\n \"ringing_timeout\": \"10s\",\n \"max_call_duration\": \"30s\",\n \"media_encryption\": \"SIP_MEDIA_ENCRYPT_DISABLE\",\n \"phone_number_purchase\": null,\n \"meta\": {\n \"message\": \"Inbound Sip Trunk created successfully.\"\n }\n}"}],"_postman_id":"9d9b7a0a-9da9-4dd4-9b06-10a7ca6f3ceb"},{"name":"show","id":"b6fd1f67-5d16-47a0-a0d2-1b967e3547b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","description":"This endpoint allows users to retrieves details about an Inbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique Identifier for Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"2f4ee849-1475-415f-83fe-c3a4e820104e","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","inbound_sip_trunk"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique Identifier for Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"c2ef875648001183aa089ccb4ee807c7\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"5edbad1e-64d0-459d-8db5-26a9ef6508a1"},{"key":"x-runtime","value":"0.053023"},{"key":"server-timing","value":"sql.active_record;dur=3.32, instantiation.active_record;dur=0.39, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.45, process_action.action_controller;dur=8.70"},{"key":"Content-Length","value":"515"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 52,\n \"name\": \"AB my inbound\",\n \"sip_trunk_id\": \"ST_9s3VMHQNcJhg\",\n \"provider\": \"twilio\",\n \"additional_config\": {},\n \"numbers\": [\n \"+15878573890\"\n ],\n \"auth_password\": \"supersecurepassword\",\n \"auth_username\": \"sipuser123\",\n \"allowed_numbers\": [\n \"+15878573890\"\n ],\n \"ringing_timeout\": \"10s\",\n \"media_encryption\": \"SIP_MEDIA_ENCRYPT_DISABLE\",\n \"allowed_addresses\": [\n \"192.168.1.0/24\",\n \"10.0.0.1\"\n ],\n \"max_call_duration\": \"30s\",\n \"phone_number_purchase\": null,\n \"meta\": null\n}"}],"_postman_id":"b6fd1f67-5d16-47a0-a0d2-1b967e3547b0"},{"name":"destroy","id":"0436787c-8310-442f-93e9-d8421ab18bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","description":"This endpoint allows users to destroy an Inbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"04c971cf-3bf7-4ef7-87bf-d5fa0a92f2d3","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","inbound_sip_trunk"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"875b76279d3c7750e0f43d11f97a3770\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"a3585ca5-ba5d-4911-93be-ca5926d77152"},{"key":"x-runtime","value":"2.240870"},{"key":"server-timing","value":"sql.active_record;dur=75.26, instantiation.active_record;dur=29.08, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.02, transaction.active_record;dur=5.59, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=1994.61"},{"key":"Content-Length","value":"64"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Inbound Sip Trunk destroyed successfully.\"\n }\n}"}],"_postman_id":"0436787c-8310-442f-93e9-d8421ab18bae"},{"name":"update","id":"e96ae915-f02d-4379-af98-95f41d2ad30d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"name\": \"AB update\",\n \"numbers\": [\"+15878573895\"],\n \"allowed_addresses\": [\"192.168.1.0/24\", \"10.0.0.1\"],\n \"allowed_numbers\": [\"+15878573895\"],\n \"auth_username\": \"admin\",\n \"auth_password\": \"supur_admin\",\n \"ringing_timeout\": \"10s\",\n \"max_call_duration\": \"30s\",\n \"media_encryption\": 0\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","description":"This endpoint allows users to update the details of an Inbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"1857de33-92ab-4e0a-afa6-09f00e1c568a","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"name\": \"AB\",\n \"numbers\": [\"+15878573890\"],\n \"allowed_addresses\": [\"192.168.1.0/24\", \"10.0.0.1\"],\n \"allowed_numbers\": [\"+15878573890\"],\n \"auth_username\": \"sipuser123\",\n \"auth_password\": \"supersecurepassword\",\n \"ringing_timeout\": \"10s\",\n \"max_call_duration\": \"30s\",\n \"media_encryption\": 0\n }\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/inbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","inbound_sip_trunk"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"b111c854a5b4ff2a7cc0680875fa6c17\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"2b6b40a3-d17a-4d1f-a327-957a677d6f0a"},{"key":"x-runtime","value":"2.226842"},{"key":"server-timing","value":"sql.active_record;dur=24.36, instantiation.active_record;dur=0.48, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.01, transaction.active_record;dur=6.42, render.active_model_serializers;dur=1.24, process_action.action_controller;dur=2197.74"},{"key":"Content-Length","value":"553"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 52,\n \"name\": \"AB\",\n \"sip_trunk_id\": \"ST_9s3VMHQNcJhg\",\n \"provider\": \"twilio\",\n \"additional_config\": {},\n \"numbers\": [\n \"+15878573890\"\n ],\n \"allowed_addresses\": [\n \"192.168.1.0/24\",\n \"10.0.0.1\"\n ],\n \"allowed_numbers\": [\n \"+15878573890\"\n ],\n \"auth_username\": \"sipuser123\",\n \"auth_password\": \"supersecurepassword\",\n \"ringing_timeout\": \"10s\",\n \"max_call_duration\": \"30s\",\n \"media_encryption\": \"SIP_MEDIA_ENCRYPT_DISABLE\",\n \"phone_number_purchase\": null,\n \"meta\": {\n \"message\": \"Inbound Sip Trunk updated successfully.\"\n }\n}"}],"_postman_id":"e96ae915-f02d-4379-af98-95f41d2ad30d"}],"id":"488be0b5-3d72-4d33-9b6c-96fd8b02f2d6","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"provider\": 0,\n \"name\": \"Ab trunk\",\n \"address\": \"kick.pstn.twilio.com\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"transport\": 0,\n \"auth_username\": \"kickcall_local_user\",\n \"auth_password\": \"Lol@2020Lol@2020\",\n \"media_encryption\": 0,\n \"destination_country\": \"US\",\n \"additional_config\": {\n \"pstn_trunk_name\": \"abc\",\n \"kickcall_trunk_name\": \"abc\",\n \"override_from\": \"abc\"\n }\n }\n}"},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","description":"This endpoint allows users to create a new Outbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"e33ac757-b1b9-4564-9ef2-9b9fc95ceedf","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"provider\": 0,\n \"name\": \"Ab trunk\",\n \"address\": \"kick.pstn.twilio.com\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"transport\": 0,\n \"auth_username\": \"kickcall_local_user\",\n \"auth_password\": \"Lol@2020Lol@2020\",\n \"media_encryption\": 0,\n \"destination_country\": \"US\",\n \"additional_config\": {\n \"X-PSTN-TRUNK-NAME\": \"abc\",\n \"X-Kickcall-Trunk-Name\": \"abc\",\n \"X-OVERRIDE-FROM\": \"abc\"\n }\n }\n}"},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","outbound_sip_trunk"],"query":[{"key":"","value":null,"disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"597a6e5ba8d0e032e0a73dd9587a2227\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"0dfaa1db-599d-4646-ae1d-2a6eff7ffcb4"},{"key":"x-runtime","value":"1.704694"},{"key":"server-timing","value":"sql.active_record;dur=43.83, instantiation.active_record;dur=0.70, start_processing.action_controller;dur=0.01, unpermitted_parameters.action_controller;dur=0.01, start_transaction.active_record;dur=0.02, transaction.active_record;dur=8.22, render.active_model_serializers;dur=1.01, process_action.action_controller;dur=1566.46"},{"key":"Content-Length","value":"536"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 53,\n \"name\": \"Ab trunk\",\n \"direction\": \"outbound\",\n \"sip_trunk_id\": \"ST_yD5HR83Qna5x\",\n \"provider\": \"twilio\",\n \"additional_config\": {\n \"pstn_trunk_name\": \"abc\",\n \"kickcall_trunk_name\": \"abc\",\n \"override_from\": \"abc\"\n },\n \"address\": \"kick.pstn.twilio.com\",\n \"destination_country\": \"US\",\n \"transport\": \"SIP_TRANSPORT_AUTO\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"auth_username\": \"kickcall_local_user\",\n \"auth_password\": \"Lol@2020Lol@2020\",\n \"media_encryption\": \"SIP_MEDIA_ENCRYPT_DISABLE\",\n \"phone_number_purchase\": null,\n \"meta\": {\n \"message\": \"Outbound Sip Trunk created successfully.\"\n }\n}"}],"_postman_id":"617778c6-4a8d-49ac-9bf7-b53f45fe255e"},{"name":"show","id":"a63f999d-2fab-4a3d-ba10-d8bfbdc0a4e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","description":"This endpoint allows users to retrieves details about an Outbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"a1dbdf31-f4c9-488a-b45c-1007cc86bd9f","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","outbound_sip_trunk"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"3d172ee228b097f408814bbd762d6ba0\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"d90c2a3f-6ca9-4dda-b086-29b6c7761bd2"},{"key":"x-runtime","value":"0.076959"},{"key":"server-timing","value":"sql.active_record;dur=8.03, instantiation.active_record;dur=0.55, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.44, process_action.action_controller;dur=15.30"},{"key":"Content-Length","value":"486"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 53,\n \"name\": \"Ab trunk\",\n \"direction\": \"outbound\",\n \"sip_trunk_id\": \"ST_yD5HR83Qna5x\",\n \"provider\": \"twilio\",\n \"additional_config\": {\n \"X-OVERRIDE-FROM\": \"abc\",\n \"X-PSTN-TRUNK-NAME\": \"abc\",\n \"X-Kickcall-Trunk-Name\": \"abc\"\n },\n \"address\": \"kick.pstn.twilio.com\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"transport\": \"SIP_TRANSPORT_AUTO\",\n \"auth_password\": \"Lol@2020Lol@2020\",\n \"auth_username\": \"kickcall_local_user\",\n \"media_encryption\": \"SIP_MEDIA_ENCRYPT_DISABLE\",\n \"destination_country\": \"US\",\n \"phone_number_purchase\": null,\n \"meta\": null\n}"}],"_postman_id":"a63f999d-2fab-4a3d-ba10-d8bfbdc0a4e9"},{"name":"destroy","id":"8beaf0f3-3df3-4f7d-a39d-78f10d39e222","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","description":"This endpoint allows users to destroy an Outbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the SIP Trunk
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"0eecd335-afcd-4b00-87a6-5c353e36578f","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","outbound_sip_trunk"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the SIP Trunk"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"762786ce559364520e8712b41b0eaca0\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"3973a2c4-66ea-49fe-a925-c3983c071d80"},{"key":"x-runtime","value":"1.999607"},{"key":"server-timing","value":"sql.active_record;dur=19.91, instantiation.active_record;dur=1.14, start_processing.action_controller;dur=0.00, start_transaction.active_record;dur=0.02, transaction.active_record;dur=3.34, render.active_model_serializers;dur=0.11, process_action.action_controller;dur=1952.86"},{"key":"Content-Length","value":"65"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Outbound Sip Trunk destroyed successfully.\"\n }\n}"}],"_postman_id":"8beaf0f3-3df3-4f7d-a39d-78f10d39e222"},{"name":"update","id":"e3ef22b2-96c6-4e83-bad1-66fcd743d27a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"name\": \"AbNew trunk\",\n \"address\": \"kick.pstn.com\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"transport\": 0,\n \"auth_username\": \"abc\",\n \"auth_password\": \"admin123\",\n \"media_encryption\": 0,\n \"destination_country\": \"US\",\n \"additional_config\": {\n \"pstn_trunk_name\": \"a\",\n \"kickcall_trunk_name\": \"a\",\n \"override_from\": \"a\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","description":"This endpoint allows users to update the details of an Outbound SIP trunk for a specific agent within a given workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the Agent
\n","type":"text/plain"},"type":"any","value":"1","key":"agent_id"}]}},"response":[{"id":"04863890-9841-413e-92a5-47bb003ae8c5","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trunk\": {\n \"name\": \"AbNew trunk\",\n \"address\": \"kick.pstn.com\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"transport\": 0,\n \"auth_username\": \"abc\",\n \"auth_password\": \"admin123\",\n \"media_encryption\": 0,\n \"destination_country\": \"US\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/outbound_sip_trunk","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","outbound_sip_trunk"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"1","description":"Unique identifier for the Agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"e0fd5f43a4e6cac4e9bd2642c38a00ca\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"7c98d5dd-ee86-4ff6-8fb8-e9f53414a5da"},{"key":"x-runtime","value":"1.511982"},{"key":"server-timing","value":"sql.active_record;dur=7.38, instantiation.active_record;dur=0.55, start_processing.action_controller;dur=0.00, unpermitted_parameters.action_controller;dur=0.04, start_transaction.active_record;dur=0.01, transaction.active_record;dur=2.85, render.active_model_serializers;dur=0.61, process_action.action_controller;dur=1478.47"},{"key":"Content-Length","value":"508"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 53,\n \"name\": \"AbNew trunk\",\n \"direction\": \"outbound\",\n \"sip_trunk_id\": \"ST_yD5HR83Qna5x\",\n \"provider\": \"twilio\",\n \"additional_config\": {\n \"X-OVERRIDE-FROM\": \"abc\",\n \"X-PSTN-TRUNK-NAME\": \"abc\",\n \"X-Kickcall-Trunk-Name\": \"abc\"\n },\n \"address\": \"kick.pstn.com\",\n \"destination_country\": \"US\",\n \"transport\": \"SIP_TRANSPORT_AUTO\",\n \"numbers\": [\n \"+15878573890\"\n ],\n \"auth_username\": \"abc\",\n \"auth_password\": \"admin123\",\n \"media_encryption\": \"SIP_MEDIA_ENCRYPT_DISABLE\",\n \"phone_number_purchase\": null,\n \"meta\": {\n \"message\": \"Outbound Sip Trunk updated successfully.\"\n }\n}"}],"_postman_id":"e3ef22b2-96c6-4e83-bad1-66fcd743d27a"}],"id":"f2b383a5-c8e9-4f37-9fa7-ad3866694972","description":"SIP Trunks (Session Initiation Protocol Trunks) are virtual phone lines that allow the agency or business to make and receive voice calls over the internet via VoIP infrastructure. They act as the bridge between your platform and the traditional phone network (PSTN), enabling scalable, cost-effective telephony. SIP Trunks are used to manage call routing, caller IDs, and voice connectivity across agents and systems.
\nEnum. Valid values are as follows:
\nEnum. Valid values are as follows:
\n","_postman_id":"82449ec7-b1b7-4bae-8766-c583cc2bf2bb"},{"name":"Signals","item":[{"name":"index","id":"f8e66542-c289-453b-8c59-bccc82c4a45e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/signals","description":"This endpoint allows you to retrieve interactions associated with a specific agent within a designated workspace. The interactions can be filtered based on the source type and additional source information.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"}]}},"response":[{"id":"8c813648-d064-4af4-ae5f-6748478c20ae","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/signals","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","signals"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"171","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 27 Jun 2025 13:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"17201"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"fbb08ae888003585c92a2ed425155943\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"f5b16484-1bde-48e7-b6dc-9af790327ed8"},{"key":"x-runtime","value":"0.090529"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"f8e66542-c289-453b-8c59-bccc82c4a45e"},{"name":"show","id":"20d6eb20-5787-4825-b8e5-270707b072f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/signals/:id","description":"This endpoint retrieves details about a specific interaction associated with a particular agent in a specified workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"},{"description":{"content":"Unique identifier for the signal
\n","type":"text/plain"},"type":"any","value":"2937","key":"id"}]}},"response":[{"id":"d8657dd5-284c-4786-a5a0-e77c6ff207c2","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/signals/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","agents",":agent_id","signals",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"agent_id","value":"171","description":"Unique identifier for the agent"},{"key":"id","value":"2937","description":"Unique identifier for the signal"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 27 Jun 2025 13:22:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"894"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"a174f18059b14179adfdfd5ae47c3728\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"89f974f3-5e1c-4704-af98-ab9e5c9debca"},{"key":"x-runtime","value":"0.021555"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"20d6eb20-5787-4825-b8e5-270707b072f3"},{"name":"update","id":"ca606725-c05b-44f7-84cc-53f1d83fb348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/signals/:id","description":"This endpoint retrieves details about a specific interaction associated with a particular agent in a specified workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"},{"description":{"content":"Unique identifier for the signal
\n","type":"text/plain"},"type":"any","value":"2937","key":"id"}]}},"response":[],"_postman_id":"ca606725-c05b-44f7-84cc-53f1d83fb348"},{"name":"delete","id":"405cb285-a720-4244-9d04-9611bdce263b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/agents/:agent_id/signals/:id","description":"This endpoint retrieves details about a specific interaction associated with a particular agent in a specified workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"171","key":"agent_id"},{"description":{"content":"Unique identifier for the signal
\n","type":"text/plain"},"type":"any","value":"2937","key":"id"}]}},"response":[],"_postman_id":"405cb285-a720-4244-9d04-9611bdce263b"}],"id":"d785d991-d5eb-4574-9ccc-41a1da729c42","description":"The Signals API allows clients to fetch, view, and manage sentiment-driven insights extracted from customer conversations. These signals are generated through AI-based sentiment analysis to detect key intents such as appointment bookings, confirmations, cancellations, or customer frustrations - helping teams monitor performance without manually listening to every call.
\nEach signal is tied to a specific agent and can be system-generated or customized by the user.
\n","_postman_id":"d785d991-d5eb-4574-9ccc-41a1da729c42"}],"id":"6d267036-b595-40e8-959e-cf8ebf8c8384","description":"An Agent is an interactive entity responsible for handling user interactions such as voice calls.
Agents operate based on their assigned configurations, which define their behavior, available actions, integrated services, and response logic. Each agent can be customized to suit specific business workflows or customer service needs.
The response will be in JSON format and includes the following structure:
\n","_postman_id":"6d267036-b595-40e8-959e-cf8ebf8c8384"},{"name":"Available Integrations","item":[{"name":"index","id":"ef77c885-558d-465f-bd69-2f4bfd0cc618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/available_integrations","description":"This endpoint retrieves a list of available integrations for a specified workspace. The results can be filtered based on integration name and category.
\nA substring to filter the names of the integrations. Only integrations containing this substring in their name will be returned.
\n","type":"text/plain"},"key":"filter[name_cont]","value":"zapier"},{"disabled":true,"description":{"content":"An integer representing the category ID to filter the integrations. Only integrations belonging to this category will be included in the response.
\n","type":"text/plain"},"key":"filter[category_eq]","value":"2"}],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"95270c76-aef6-4ca5-a880-72775b5d0bf4","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/available_integrations","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","available_integrations"],"query":[{"key":"filter[name_cont]","value":"zapier","description":"A substring to filter the names of the integrations. Only integrations containing this substring in their name will be returned.","disabled":true},{"key":"filter[category_eq]","value":"2","description":"An integer representing the category ID to filter the integrations. Only integrations belonging to this category will be included in the response.","disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 27 Jun 2025 13:32:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4890"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"2fec9dabb1bb5e6b600b5efb24f647c0\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"34491a43-0097-487e-a43d-28a1939ed095"},{"key":"x-runtime","value":"0.134627"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 14,\n \"name\": \"Zendesk\",\n \"code\": \"zendesk\",\n \"description\": \"Zendesk is a customer service and engagement platform that streamlines support tickets, automates workflows, and improves customer interactions across channels.\",\n \"category\": \"automation\",\n \"connection_type\": \"credentials\",\n \"small_avatar_url\": \"https://api-appstag.kickcall.ai/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjA5MSwicHVyIjoiYmxvYl9pZCJ9fQ==--62cd3fcf0aeef339d7ccdd27f4463e3a50ff5146/zendesk_small.png\",\n \"avatar_url\": \"https://api-appstag.kickcall.ai/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjA5MCwicHVyIjoiYmxvYl9pZCJ9fQ==--585d3562cd11eed4c0322b93bad44db02fcf75d7/zendesk.png\"\n },\n {\n \"id\": 15,\n \"name\": \"MCP\",\n \"code\": \"mcp\",\n \"description\": \"MCP is a server management platform that provides centralized control, automation, and monitoring for infrastructure across data centers and cloud environments.\",\n \"category\": \"automation\",\n \"connection_type\": \"credentials\",\n \"small_avatar_url\": \"https://api-appstag.kickcall.ai/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjA5MywicHVyIjoiYmxvYl9pZCJ9fQ==--40c23f6f9deba4e02437747303192009653b4a17/mcp_small.png\",\n \"avatar_url\": \"https://api-appstag.kickcall.ai/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MjA5MiwicHVyIjoiYmxvYl9pZCJ9fQ==--cdabe3f982c6ffeecfdd08a85810a6e4209a0735/mcp.png\"\n }\n ],\n \"links\": {\n \"self\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/available_integrations\",\n \"next\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/available_integrations?page=1\",\n \"prev\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/available_integrations?page=1\",\n \"last\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/available_integrations?page=1\",\n \"first\": \"http://api-appstag.kickcall.ai/api/v1/business/workspaces/1/available_integrations?page=1\"\n },\n \"meta\": {\n \"count\": 2,\n \"total_count\": 2,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"ef77c885-558d-465f-bd69-2f4bfd0cc618"}],"id":"86595886-6eb4-486e-8f1c-335f46a26ed6","description":"Available integrations are third-party services that businesses can connect — including CRMs, calendars, communication platforms, EHR/EMR systems, and other tools. These integrations enable agents to access and interact with real-time data during calls, enhancing efficiency and customer experience.
\nThe response will be in JSON format and includes the following structure:
\n","_postman_id":"86595886-6eb4-486e-8f1c-335f46a26ed6"},{"name":"Integrations","item":[{"name":"new","id":"b4e2a5d5-6d60-45ac-9606-15adfbde201c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"},{"key":"Authorization","value":"Bearer {{api_key}}","description":"Provide your API Key in the Authorization request header with the Bearer authentication scheme.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/new","description":"This HTTP GET request is used to retrieve the integration configuration for a particular integration. The integration is identified using a code passed as a query parameter.
Code to get the configuration parameter that needed to create the integration.
\n","type":"text/plain"},"key":"code","value":"zendesk"}],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"b8602045-45cf-42f8-ba17-45774f92bce3","name":"new","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/new?code=mcp","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","integrations","new"],"query":[{"key":"code","value":"mcp"}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"247309eedc34c3dd79766a9f7debd5b2\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"11a309f7-2300-4418-a3f2-31ca46b5d2ad"},{"key":"x-runtime","value":"0.057838"},{"key":"server-timing","value":"sql.active_record;dur=17.11, instantiation.active_record;dur=0.20, start_processing.action_controller;dur=0.00, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=23.44"},{"key":"Content-Length","value":"243"}],"cookie":[],"responseTime":null,"body":"{\n \"integration_name\": \"Integrations::Mcp\",\n \"configuration\": [\n {\n \"key\": \"server_url\",\n \"required\": true\n },\n {\n \"key\": \"timeout\",\n \"required\": true\n },\n {\n \"key\": \"description\",\n \"required\": false\n },\n {\n \"key\": \"server_token\",\n \"required\": false\n },\n {\n \"key\": \"headers\",\n \"required\": false\n }\n ]\n}"}],"_postman_id":"b4e2a5d5-6d60-45ac-9606-15adfbde201c"},{"name":"create-Zendesk","id":"8211efa2-a474-4ae3-b008-14ca82b00bd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_name\": \"Integrations::Zendesk\",\n \"name\": \"Zendesk\",\n \"configuration\": {\n \"api_key\": \"XXXXXXXXX\",\n \"subdomain\": \"ZENDESK_SUBDOMAIN\",\n \"email\": \"dev@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations","description":"This endpoint allows you to create a new integration within a specified workspace. It is designed to facilitate the connection of external services to your business's workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"317b545f-80e7-497c-bfe1-eaaa7e7f9563","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"integration_name\": \"Integrations::Zendesk\",\n \"name\": \"Zendesk\",\n \"configuration\": {\n \"api_key\": \"XXXXXXXXX\",\n \"subdomain\": \"ZENDESK_SUBDOMAIN\",\n \"email\": \"dev@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","integrations"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"1a9c771ab89255ecffcf81ed2b2077a5\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"bdcd038d-6529-4de1-a418-d7cf0f0f7a2f"},{"key":"x-runtime","value":"5.290711"},{"key":"server-timing","value":"sql.active_record;dur=51.26, start_processing.action_controller;dur=0.01, instantiation.active_record;dur=2.35, start_transaction.active_record;dur=0.01, transaction.active_record;dur=24.51, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=5182.50"},{"key":"Content-Length","value":"55"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Zendesk integrated successfully.\"\n }\n}"}],"_postman_id":"8211efa2-a474-4ae3-b008-14ca82b00bd7"},{"name":"index","id":"d61d318d-0626-4b64-9e27-ab748dcadfb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations","description":"This endpoint retrieves a list of integrations associated with a specific workspace.
\nFilter from the list of the categories we have for the integration
\n","type":"text/plain"},"key":"filter[category_eq]","value":"calendar_management"}],"variable":[{"description":{"content":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"}]}},"response":[{"id":"c20bfd38-a159-4b78-8c17-6c91b17b00fb","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","integrations"],"query":[{"key":"filter[category_eq]","value":"calendar_management","description":"Filter from the list of the categories we have for the integration","disabled":true}],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"e29198ed215900174db617246cd3a734\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"4b333dc5-aa65-4c61-92c9-ba40f719393b"},{"key":"x-runtime","value":"0.101396"},{"key":"server-timing","value":"sql.active_record;dur=18.10, instantiation.active_record;dur=0.99, start_processing.action_controller;dur=0.01, unpermitted_parameters.action_controller;dur=0.02, render.active_model_serializers;dur=4.11, process_action.action_controller;dur=15.65"},{"key":"Content-Length","value":"1590"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4,\n \"code\": \"zendesk\",\n \"configuration\": {\n \"email\": \"jan_doe@example.com\",\n \"api_key\": \"XXXXXXXXXX\",\n \"headers\": [],\n \"subdomain\": \"https://appstag.kickcall.ai/\"\n },\n \"active\": true,\n \"pretty_name\": \"Zendesk\",\n \"name\": \"Zendesk\",\n \"updated_at\": \"2025-07-07T02:09:22.976-05:00\"\n },\n {\n \"id\": 5,\n \"code\": \"mcp\",\n \"configuration\": {\n \"headers\": [],\n \"timeout\": \"10\",\n \"server_url\": \"https://appstag.kickcall.ai\",\n \"description\": \"Model context protocol\",\n \"server_token\": \"XXXXXXXXXXXXX\"\n },\n \"active\": true,\n \"pretty_name\": \"Mcp\",\n \"name\": \"MCP\",\n \"updated_at\": \"2025-07-07T02:10:18.377-05:00\"\n }\n ],\n \"links\": {\n \"self\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/integrations\",\n \"next\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/integrations?page=1\",\n \"prev\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/integrations?page=1\",\n \"last\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/integrations?page=1\",\n \"first\": \"http://api-kickcall.lvh.me:3000/api/v1/business/workspaces/1/integrations?page=1\"\n },\n \"meta\": {\n \"count\": 2,\n \"total_count\": 2,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"d61d318d-0626-4b64-9e27-ab748dcadfb0"},{"name":"update","id":"f4f4c304-037d-4ecd-9450-a61ff84192f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"configuration\": {\n \"email\": \"jane@example.com\",\n \"api_key\": \"XXXXXXXX\",\n \"subdomain\": \"https://appstag.kickcall.ai/\"\n },\n \"name\": \"Zendesks\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/:id","description":"This endpoint allows you to update an existing integration within a specified workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the integration
\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[{"id":"5e9fc1d6-113a-4d46-80d3-9d73d2b3c1c4","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"configuration\": {\n \"email\": \"jane@example.com\",\n \"api_key\": \"XXXXXXXX\",\n \"subdomain\": \"https://appstag.kickcall.ai/\"\n },\n \"name\": \"Zendesks\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","integrations",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"id","value":"4","description":"Unique identifier for the integration"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"138bd86c60fb6923c418abbc467e3ddb\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"4a090580-7ad5-4972-8a43-35f8ea77bb35"},{"key":"x-runtime","value":"0.095363"},{"key":"server-timing","value":"sql.active_record;dur=24.36, instantiation.active_record;dur=0.91, start_processing.action_controller;dur=0.01, start_transaction.active_record;dur=0.00, transaction.active_record;dur=2.69, render.active_model_serializers;dur=0.42, process_action.action_controller;dur=19.16"},{"key":"Content-Length","value":"290"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"code\": \"zendesk\",\n \"configuration\": {\n \"email\": \"jane@example.com\",\n \"api_key\": \"XXXXXXXX\",\n \"subdomain\": \"https://appstag.kickcall.ai/\"\n },\n \"active\": true,\n \"pretty_name\": \"Zendesk\",\n \"name\": \"Zendesks\",\n \"updated_at\": \"2025-07-07T02:15:22.577-05:00\",\n \"meta\": {\n \"message\": \"Integration updated successfully.\"\n }\n}"}],"_postman_id":"f4f4c304-037d-4ecd-9450-a61ff84192f2"},{"name":"show","id":"f8b26dd1-5fc8-4ae9-ae65-ffc892cddd23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/:id","description":"This endpoint retrieves detailed information about a specific integration within a workspace. It allows users to access the configuration and status of a particular integration identified by its unique ID.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the agent
\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[{"id":"ebcaeb10-6394-40fd-a0b1-4ed5fae70a6c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","integrations",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"id","value":"4","description":"Unique identifier for the agent"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"2cce56e0f2d8cebbae10b14bd6bbbed9\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"6b605101-3c12-4bb0-8904-a4ee2eba473a"},{"key":"x-runtime","value":"0.097164"},{"key":"server-timing","value":"sql.active_record;dur=4.84, instantiation.active_record;dur=0.78, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.52, process_action.action_controller;dur=21.23"},{"key":"Content-Length","value":"247"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"code\": \"zendesk\",\n \"configuration\": {\n \"email\": \"jane@example.com\",\n \"api_key\": \"XXXXXXXX\",\n \"subdomain\": \"https://appstag.kickcall.ai/\"\n },\n \"active\": true,\n \"pretty_name\": \"Zendesk\",\n \"name\": \"Zendesks\",\n \"updated_at\": \"2025-07-07T02:15:22.577-05:00\",\n \"meta\": null\n}"}],"_postman_id":"f8b26dd1-5fc8-4ae9-ae65-ffc892cddd23"},{"name":"destroy","id":"01f01ddc-ea8d-4041-8d4a-86a269bdc0c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/:id","description":"This endpoint allows you to delete an existing integration within a specified workspace.
\nUnique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations.
\n","type":"text/plain"},"type":"any","value":"{{workspace_id}}","key":"workspace_id"},{"description":{"content":"Unique identifier for the integration
\n","type":"text/plain"},"type":"any","value":"79","key":"id"}]}},"response":[{"id":"8a0f77f5-d6e6-40df-b11f-a584fe4bc461","name":"destroy","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/workspaces/:workspace_id/integrations/:id","host":["{{base_url}}"],"path":["api","v1","business","workspaces",":workspace_id","integrations",":id"],"variable":[{"key":"workspace_id","value":"{{workspace_id}}","description":"Unique identifier for the workspace the request is associated with. A workspace typically represents a team or an operational unit within the business, grouping users, agents, and related configurations."},{"key":"id","value":"79","description":"Unique identifier for the integration"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 03 Jul 2025 10:30:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"767cb3bc83785c827d071c112061537e\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"18d662db-71f2-4bfc-a270-f798f8d83e8d"},{"key":"x-runtime","value":"0.097135"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Integration destroyed successfully.\"\n }\n}"}],"_postman_id":"01f01ddc-ea8d-4041-8d4a-86a269bdc0c3"}],"id":"aeefe0a5-7333-4ae2-92b7-402a27765b45","description":"These are integrated/configured integrations that are ready for agents to use.
\nThe parameters required in the configuration field depend on the type of integration being created. Each integration expects a specific structure of configuration keys
Integrations::Zendesk){\n \"integration_name\": \"Integrations::Zendesk\",\n \"configuration\": [\n { \"key\": \"email\", \"required\": true },\n { \"key\": \"subdomain\", \"required\": true },\n { \"key\": \"api_key\", \"required\": true }\n ]\n}\n\nIntegrations::Mcp){\n \"integration_name\": \"Integrations::Mcp\",\n \"configuration\": [\n { \"key\": \"server_url\", \"required\": true },\n { \"key\": \"timeout\", \"required\": false },\n { \"key\": \"description\", \"required\": false },\n { \"key\": \"server_token\", \"required\": false },\n { \"key\": \"headers\", \"required\": false }\n ]\n}\n\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/operators","description":"This endpoint retrieves a list of business operators associated with the account. It is designed to provide information about each operator, including their identifiers and contact details.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"operator\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"job_title\": \"Developer\",\n \"email\": \"john.doe@example.com\",\n \"phone_number\": \"+11234567890\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/operators","description":"This endpoint allows you to create a new business operator by providing their personal and professional details.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"url":"{{base_url}}/api/v1/business/operators/:id","description":"This endpoint retrieves detailed information about a specific business operator based on their unique identifier.
\nEnsure that the id parameter is correctly provided in the URL to retrieve the desired operator's information.
Unique identifier for the operators. i.e id
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"d6faa631-4936-4755-9541-3aae88133f7c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/business/operators/:id","host":["{{base_url}}"],"path":["api","v1","business","operators",":id"],"variable":[{"key":"id","value":"1","description":"Unique identifier for the operators. i.e id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"8047a64fb3e65751e3ed1b2c7b56a6fe\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"61bdc4e8-ca47-4048-b020-7b3360212477"},{"key":"x-runtime","value":"0.083990"},{"key":"server-timing","value":"sql.active_record;dur=20.25, instantiation.active_record;dur=1.35, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=1.74, process_action.action_controller;dur=44.62"},{"key":"Content-Length","value":"157"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"first_name\": \"joey\",\n \"last_name\": \"tribbiani\",\n \"job_title\": \"developer\",\n \"email\": \"joey@example.com\",\n \"phone_number\": \"+19876543223\",\n \"meta\": null\n}"}],"_postman_id":"002bcccd-30b5-4f46-bc20-911b571629cb"},{"name":"update","id":"2bff9c4d-9e5c-4d18-b30c-ff2bb0eb3296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"operator\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Deo\",\n \"job_title\": \"Senior Developer\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+10987654321\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/operators/:id","description":"This endpoint allows you to update the details of a specific operator identified by their unique ID.
\nUnique identifier for the operators. i.e id
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"e76e6c4d-1774-4936-915f-1c817c5e51c7","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"operator\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Deo\",\n \"job_title\": \"Senior Developer\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"0987654321\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/operators/:id","host":["{{base_url}}"],"path":["api","v1","business","operators",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"70b23dc3b273384ce03d411dd2ac00e2\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"7c288204-ed34-4460-9916-7d77997b015e"},{"key":"x-runtime","value":"0.032831"},{"key":"server-timing","value":"sql.active_record;dur=15.80, instantiation.active_record;dur=0.27, start_processing.action_controller;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=13.47, render.active_model_serializers;dur=1.23, process_action.action_controller;dur=25.20"},{"key":"Content-Length","value":"145"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Jane\",\n \"last_name\": \"Deo\",\n \"job_title\": \"Senior Developer\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"0987654321\"\n }\n}"}],"_postman_id":"2bff9c4d-9e5c-4d18-b30c-ff2bb0eb3296"},{"name":"delete","id":"d2b46714-600d-4885-a817-656164a27023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/operators/:id","description":"This endpoint allows you to delete a specific operator from the database using their unique identifier (ID).
\nUnique identifier for the operators. i.e id
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"7410030f-80e6-46b8-8174-8403fcb9aebe","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Business-Id","value":"{{Business-Id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/api/v1/business/operators/:id","host":["{{base_url}}"],"path":["api","v1","business","operators",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"42c071e1f72862b42f02b892762c4e66\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ca9f9ffe-73a0-454f-b7f0-421c0bf44ed8"},{"key":"x-runtime","value":"0.038903"},{"key":"server-timing","value":"sql.active_record;dur=17.64, instantiation.active_record;dur=3.56, start_processing.action_controller;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=12.20, render.active_model_serializers;dur=0.07, process_action.action_controller;dur=31.06"},{"key":"Content-Length","value":"43"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"operator successfully deleted\"\n}"}],"_postman_id":"d2b46714-600d-4885-a817-656164a27023"}],"id":"2440e76a-f0f3-4d6d-abfc-86d52abb28be","description":"An Operator refers to a human user—such as a customer service representative, front desk staff, or receptionist—who is designated to handle calls or interactions forwarded by an Agent, typically after escalation.
\nOperators serve as the final point of contact for situations that require human intervention beyond the Agent’s capabilities.
\nThe response will be in JSON format and includes the following structure:
\n","_postman_id":"2440e76a-f0f3-4d6d-abfc-86d52abb28be"},{"name":"Business Profile","item":[{"name":"Show","id":"5cff5a19-46c9-4999-8365-7783c570f197","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/business/business_profiles","description":"This endpoint retrieves a list of business profiles It returns detailed information about each business, including identifiers, contact information, and related workspaces.
\nUnique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"business[name]","value":"test","type":"text"},{"key":"business[legal_name]","value":"test name","type":"text"},{"key":"business[email]","value":"test@gmail.com","type":"text"},{"key":"business[phone]","value":"19876543211","type":"text"},{"key":"business[website]","value":"test.com","type":"text"},{"key":"business[niche]","value":"test","type":"text"},{"key":"business[avatar]","type":"file","src":"/home/bluebash/Downloads/file_example_JPG_100kB.jpg"},{"key":"business[address_attributes][street_address]","value":"Saunta Vaddo, Calangute Baga Road,","type":"text"},{"key":"business[address_attributes][city]","value":"Baga","type":"text"},{"key":"business[address_attributes][state]","value":"Goa","type":"text"},{"key":"business[address_attributes][postal_code]","value":"403516","type":"text"},{"key":"business[address_attributes][country]","value":"India","type":"text"},{"key":"business[address_attributes][time_zone]","value":"Asia/Kolkata","type":"text"},{"key":"business[address_attributes][platform_language]","value":"Hindi","type":"text"}]},"url":"{{base_url}}/api/v1/business/business_profiles","description":"This endpoint allows you to update an existing business profile.
\nContains endpoints related to viewing and updating the core profile details of a Business.
\nIt includes key information such as the business name, contact details, branding assets, billing identifiers, and subscription metadata.
\nThe response will be in JSON format and includes the following structure:
\n","_postman_id":"04243311-d2b2-40c8-960f-37fa8210e746"},{"name":"Countries","item":[{"name":"countries","id":"b43e9b13-2c52-4b43-97a0-d63aa507a1d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/business/countries","description":"This endpoint retrieves a list of countries supported by the API. It does not require any request parameters.
\nThis endpoint retrieves a list of states for a specified country based on the provided country code.
\nThe response will be in JSON format and includes the following structure:
\n","_postman_id":"afd07e17-a0b9-4324-ad81-1188fcde0b38"}],"id":"19d83910-3aba-4696-99c8-f565150c11b5","description":"A Business in Kickcall.ai represents a single company or client. It serves as the central unit where:
\nAll agents operate under one shared structure
\nResources and interactions are organized
\nAccess is shared across team members for seamless collaboration
\nAgent activity and performance contribute directly to the business
\nNotes:
\nAll business-related API requests must include the Business-Id header.
Most APIs within the Business module are scoped by workspace—use workspace_id = 1, which is the default workspace for your business.
All files in our system are uploaded and managed through blob storage.
\nAll attachments in our system are expected to follow the Active Storage blob object format.
\nThis endpoint retrieves a list of businesses associated with an agency. It is useful for obtaining information about businesses, including their details and associated users.
\nThis endpoint allows users to create a new business entry within the agency. The request requires a JSON payload containing the business details.
\nThis endpoint retrieves detailed information about a specific business associated with the provided business ID. It is useful for obtaining comprehensive data about a business, including its subscription status, contact information, and associated workspaces.
\nThis endpoint allows you to update the information of a specific business associated with an agency. You will need to provide the unique identifier of the business in the URL path.
\nThis endpoint is used to delete a specific business entity associated with an agency. The :id in the URL path should be replaced with the unique identifier of the business you wish to remove.
This endpoint retrieves a list of agent templates associated with an agency. It allows users to access various attributes of each agent template, including their identifiers, names, languages, and other characteristics.
\nThis endpoint retrieves the details of a specific agent template based on the provided unique identifier (id). It is useful for fetching configuration and properties of an agent template that can be used in various applications.
Unique identifier for the agent template
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"97912e0c-4920-48a4-a645-e3779e64bef0","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/agency/agent_templates/:id","host":["{{base_url}}"],"path":["api","v1","agency","agent_templates",":id"],"variable":[{"key":"id","value":"1","description":"Unique identifier for the agent template"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"a6751d3eeedd4354f13a216a5ca3da54\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"5fcb5aa9-818e-43d7-9ada-d3ab59a0dd7d"},{"key":"x-runtime","value":"0.086995"},{"key":"server-timing","value":"sql.active_record;dur=20.70, instantiation.active_record;dur=0.89, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=9.39, process_action.action_controller;dur=18.54"},{"key":"Content-Length","value":"9178"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Property Reconnector\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"# Who You Are\\nYou are [Alex], a professional and proactive Voice AI assistant for [Property Reconnect], specializing in re-engaging dormant real estate leads. Your role is to confidently gather updated information from leads, identify opportunities, and book meetings for a detailed consultation. You maintain a friendly but authoritative tone, ensuring the interaction remains focused and purposeful.\\n\\n# Your Goal for the Call\\nYour primary objective is to reconnect with dormant leads, gather updated information to qualify them, and schedule a meeting to discuss their property needs and opportunities further.\\n\\n# Call Actions\\n## Greeting and Identification\\n### Introduction\\nStart the call by confirming the user's identity in a confident yet approachable tone.\\nSay something like:\\n\\\"Hi, is this [John]?\\\"\\n\\nIf they confirm, proceed with:\\n\\\"Great, this is [Alex] from [Property Reconnect]. I noticed you expressed interest in real estate opportunities a while back, and I'm reaching out to see where you stand and how we can help. Do you have a quick 40 seconds to chat?\\\"\\n\\nIf the user is hesitant or unsure, say something like:\\n\\\"I totally get it...this will just take a moment, and I'll make sure to provide you with the info you need to get back on track with this.\\\"\\n\\nDO NOT proceed without confirming their identity.\\n\\n## Determine Interest in Real Estate Opportunities\\nAsk the user about their current real estate plans directly and confidently.\\nSay something like:\\n\\\"To make the most of our time, could you let me know...are you currently considering buying, selling, or investing in property?\\\"\\n\\nIf the user confirms their interest: Proceed to the step called Assess Real Estate Needs.\\nIf they indicate no interest:\\nSay something like:\\n\\\"Understood! If your plans change in the future, feel free to reach out, and we'll be happy to assist.\\\"\\n\\nDO NOT proceed without confirming their interest level.\\n\\n## Assess Real Estate Needs\\nLet the user share their specific property goals before offering tailored guidance.\\nSay something like:\\n\\\"Tell me more about what you're looking for. Are you thinking about a new home, selling a property, or exploring investment opportunities?\\\"\\n\\n[Record Response as (user_interest)]\\n\\nOnce they answer with what they're looking to do make sure to make them feel good about their decision (use their answer as a reference to get a little more personal as well).\\n\\nDO NOT proceed without gathering this information.\\n\\n## Timeline and Budget\\nAsk targeted questions to confirm their timeline and financial considerations.\\nSay something like:\\n\\\"And when are you hoping to move forward...within the next few months, or later down the line?\\\"\\n\\n[Record Response as (moving_forward_time)]\\n\\nIf buying or investing, ask if they have a general budget or price range in mind for the property you're considering\\n\\n[Record Response as (general_price_range)]\\nIf selling, ask if they've had their property appraised recently to get an idea of its current market value?\\n\\n[Record Response as (property_value)]\\n\\nIf yes or no, acknowledge their response and proceed to the Verify Interest in Appointment Booking step\\nDO NOT proceed without confirming their timeline and financial considerations.\\n\\nVerify Interest in Appointment Booking\\nGather interest in their decisions, use the details you've already gathered from the user and convince them by giving them details about what makes [Our Company] the best.\\n\\nThe goal is to get them to book a discovery call with us.\\n\\nState something that uses the following information they provided from the responses you recorded:\\n\\n(user_interest), (moving_forward_time), (general_price_range), and (property_value)\\n\\nAlways confirm interest in this section, do not proceed to \\\"Verify and Update Contact Information\\\" without the user confirming that they want to schedule with us.\\n\\n(Remember to try to get them interested in booking a meeting with the information above)\\n\\nIf they show interest proceed to the \\\"Verify and Update Contact Information\\\" step\\n\\nVerify and Update Contact Information\\nAsk for the user's best email address in a direct manner to ensure smooth communication.\\nSay something like:\\n\\\"Awesome, well before we move forward with scheduling our call, what's the best email address for us to send over more details?\\\"\\n\\nOnce they provide the email, confirm it back to them.\\nSay something like:\\n\\\"Let me confirm that...did you say [user's email]? Is that correct?\\\"\\n\\nIf the user confirms: Proceed to the step called Appointment Booking.\\nIf they indicate the email is incorrect, politely ask for it again until confirmed.\\n\\nDO NOT proceed without collecting and confirming their email.\\n\\n## Appointment Booking\\nOnce they're ready to book, follow this structured process to confirm the details:\\nAsk for the user's best email if not already provided.\\nSay something like:\\n\\\"Could you confirm the best email for us to send the calendar invite?\\\"\\n\\nIf the user confirms the email: Proceed to gathering their time zone.\\nIf the email is incorrect, politely ask for the correct one until it matches.\\n\\nDO NOT proceed without collecting the user's email.\\n\\nAsk the user for their time zone and explain meeting times are scheduled in EST.\\nSay something like:\\n\\\"Also, could you let me know your time zone so we can coordinate meeting times? We operate in EST, so I'll match the best slots for you.\\\"\\n\\nOnce the time zone is confirmed, offer available times.\\nSay something like:\\n\\\"I have an opening for today at [Available Time 1] or tomorrow at [Available Time 2]. Would either of those work for you?\\\"\\n\\nIf those don't work, ask:\\n\\\"Not a problem...what date and time would be best for you?\\\"\\n\\nCheck their preferred time with the calendar. If it works, proceed; if not, ask for another time until agreed upon.\\n\\nOnce a time is confirmed, say something like:\\n\\\"Perfect. I've got you down for [Scheduled Day and Time]. You'll receive a calendar invite shortly...just accept it when you get it so I know you received it alright?\\\"\\n\\nDO NOT proceed without confirming the meeting time and email.\\n\\nWhen finished, proceed to the step called \\\"Call Ending\\\"\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n## Call Ending\\nWrap up the call professionally and confidently.\\nSay something like:\\n\\\"Thanks so much for taking the time to chat, [John]. We're looking forward to helping you with your real estate goals. If you need anything else, don't hesitate to reach out!\\\"\\n\\nIf you ever get cut off or interrupted, make sure to go back to saying the statement you were saying in the past.\\n\\n# Knowledge Base\\n## About Us\\n[Property Reconnect is a leading real estate network dedicated to reconnecting clients with tailored property opportunities. Whether buying, selling, or investing, our team ensures a seamless and personalized experience.]\\n\\nBusiness Address - [123 Realty Way, Austin, TX 78702]\\nBusiness Phone - [512-555-4321]\\nBusiness Email - [\\\"contact at propertyreconnect dot com\\\" (C-O-N-T-A-C-T at P-R-O-P-E-R-T-Y-R-E-C-O-N-N-E-C-T dot C-O-M)]\\n## Guardrails and Objection Handling\\n[Responding When Asked If You Are AI:]\\nSay something like:\\n\\\"Yes, I'm an AI assistant, but I'm here to make things as smooth and easy as possible, just like a real person would. Let me know how I can assist!\\\"\\n\\n[Handling Misdialed or Wrong Numbers:]\\nSay something like:\\n\\\"Thanks for letting me know! While I have you, do you know anyone who might be interested in real estate opportunities? I'd love to help!\\\"\\n\\n[If the User Mentions They're Busy:]\\nSay something like:\\n\\\"Totally understand! Would another time work better, or I can send over some info by email for you to review at your convenience?\\\"\\n\\n[Responding to Questions About Source of User's Information:]\\nSay something like:\\n\\\"You expressed interest in real estate opportunities on our platform a while back. I'm following up to see how we can help you today!\\\"\\n\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--3c988efe187a21d3798a443645e572357d7800a3/alex\",\n \"agent_interaction\": \"outbound\",\n \"agent_type\": \"receptionist\",\n \"tone\": \"professional\",\n \"goal\": \"Reconnect with potential clients interested in mortgage loans, assess their current needs, present relevant offerings, and schedule an appointment with a specialist if appropriate.\",\n \"background\": \"Allen is a Voice AI assistant at Majestic Estates, focused on re-engaging leads who previously expressed interest in mortgage loans by identifying their current needs, providing tailored information, and coordinating appointments with mortgage specialists.\",\n \"physical_location_exists\": null,\n \"industry\": \"real_estate\",\n \"agent_name\": \"Alex\",\n \"description\": \"Meet Alex, an AI representative for your Real Estate company. His role is to help reconnect with past clients and push for new deals.\",\n \"welcome_message\": \"Hi, is this [John]?\",\n \"voice_id\": \"pqHfZKP75CvOlQylNhV4\",\n \"meta\": null\n}"}],"_postman_id":"23f18e0b-597e-4c65-8b42-76b59d5c35e4"},{"name":"create","id":"d591d6d0-a1a0-4935-adfd-89b6220bc360","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Business-Id","value":"{{Business-Id}}","description":"Unique identifier for the parent business entity. This is used to scope the request under a specific business account.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"agent_template[name]","value":"test agent demo","type":"text"},{"key":"agent_template[language]","value":"english","type":"text"},{"key":"agent_template[instructions]","value":"demo instructions","type":"text"},{"key":"agent_template[voice_id]","value":"1","type":"text"},{"key":"agent_template[agent_type]","value":"customer_service","type":"text"},{"key":"agent_template[tone]","value":"professional","type":"text"},{"key":"agent_template[goal]","value":"Help customers schedule appointments and collect health information.","type":"text"},{"key":"agent_template[background]","value":"Has a background in healthcare communication.","type":"text"},{"key":"agent_template[physical_location_exists]","value":"true","type":"text"},{"key":"agent_template[industry]","value":"healthcare","type":"text"},{"key":"agent_template[avatar]","type":"file","src":"/Users/polaris/Downloads/agent"}]},"url":"{{base_url}}/api/v1/agency/agent_templates","description":"This endpoint allows users to create a new agent template in the system.
\nThis endpoint allows you to update an existing agent template identified by its unique id. You can modify various attributes of the agent template, including its name, language, instructions, voice ID, agent type, tone, goal, background, and industry.
Unique identifier for the agent templates
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"f9a8c268-8b70-46d5-8cd0-15de91c4e7ac","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"agent_template[name]","value":"test agent demo","type":"text"},{"key":"agent_template[language]","value":"english","type":"text"},{"key":"agent_template[instructions]","value":"demo instructions","type":"text"},{"key":"agent_template[voice_id]","value":"1","type":"text"},{"key":"agent_template[agent_type]","value":"customer_service","type":"text"},{"key":"agent_template[tone]","value":"professional","type":"text"},{"key":"agent_template[goal]","value":"Help customers schedule appointments and collect health information.","type":"text"},{"key":"agent_template[background]","value":"Has a background in healthcare communication.","type":"text"},{"key":"agent_template[physical_location_exists]","value":"false","type":"text"},{"key":"agent_template[industry]","value":"healthcare","type":"text"}]},"url":{"raw":"{{base_url}}/api/v1/agency/agent_templates/:id","host":["{{base_url}}"],"path":["api","v1","agency","agent_templates",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"6395601e63cfbe6ab5c574a9a166a4a6\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"d3e69c4b-339d-41fb-9f70-a7cf68c46572"},{"key":"x-runtime","value":"0.160547"},{"key":"server-timing","value":"sql.active_record;dur=20.46, instantiation.active_record;dur=1.34, start_processing.action_controller;dur=0.02, unpermitted_parameters.action_controller;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=2.72, render.active_model_serializers;dur=54.16, process_action.action_controller;dur=71.25"},{"key":"Content-Length","value":"839"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"test agent demo\",\n \"languages\": [\n \"english\"\n ],\n \"instructions\": \"demo instructions\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--3c988efe187a21d3798a443645e572357d7800a3/alex\",\n \"agent_interaction\": \"outbound\",\n \"agent_type\": \"customer_service\",\n \"tone\": \"professional\",\n \"goal\": \"Help customers schedule appointments and collect health information.\",\n \"background\": \"Has a background in healthcare communication.\",\n \"physical_location_exists\": false,\n \"industry\": \"healthcare\",\n \"agent_name\": \"Alex\",\n \"description\": \"Meet Alex, an AI representative for your Real Estate company. His role is to help reconnect with past clients and push for new deals.\",\n \"welcome_message\": \"Hi, is this [John]?\",\n \"voice_id\": \"1\",\n \"meta\": {\n \"message\": \"Agent Template updated successfully.\"\n }\n}"}],"_postman_id":"d2193329-256b-4520-b481-a41b272c6562"},{"name":"delete","id":"7b1b3b88-b8a3-4797-b635-00d27f18dc71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base_url}}/api/v1/agency/agent_templates/:id","description":"This endpoint allows you to delete a specific agent template by its unique identifier (id).
Unique identifier for the agent template
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"4fdd652c-bcce-4658-a9b5-1a479c517b2a","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/api/v1/agency/agent_templates/:id","host":["{{base_url}}"],"path":["api","v1","agency","agent_templates",":id"],"variable":[{"key":"id","value":"48"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"1391959c5f0ed5891a5a2f6877f78a85\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"a31b8aa6-59b5-4301-8f8d-4ac43f05adc3"},{"key":"x-runtime","value":"0.025478"},{"key":"server-timing","value":"sql.active_record;dur=12.19, instantiation.active_record;dur=0.10, start_processing.action_controller;dur=0.00, start_transaction.active_record;dur=0.00, transaction.active_record;dur=13.14, render.active_model_serializers;dur=0.04, process_action.action_controller;dur=18.68"},{"key":"Content-Length","value":"61"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"message\": \"Agent Template destroyed successfully.\"\n }\n}"}],"_postman_id":"7b1b3b88-b8a3-4797-b635-00d27f18dc71"}],"id":"275fcfac-6bc5-400a-af79-aa96c3274b50","description":"Agent templates are predefined configurations that serve as ready-to-use starting points for setting up new agents. These templates are tailored for various industries and use cases, making it easy to quickly deploy agents with optimized settings.
\nThis endpoint retrieves analytics related to agency usage, providing key metrics that help in understanding the performance and engagement of the agency's services.
\nmake sure type is custom_range
\n","type":"text/plain"},"key":"filter[start_date]","value":"2020-12-12"},{"disabled":true,"description":{"content":"make sure type is custom_range
\n","type":"text/plain"},"key":"filter[end_date]","value":"2020-12-12"},{"disabled":true,"key":"filter[business_id]","value":"1"},{"disabled":true,"description":{"content":"today, yesterday, last_7_days, last_30_days, this_month, last_month, custom_range
\n","type":"text/plain"},"key":"filter[type]","value":"today"}],"variable":[]}},"response":[{"id":"468494d9-d322-40e5-9b2a-52c83fd616e4","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/agency/usage/analytics?filter[start_date]=2020-12-12&filter[end_date]=2020-12-12&filter[business_id]=1&filter[type]=today","host":["{{base_url}}"],"path":["api","v1","agency","usage","analytics"],"query":[{"key":"filter[start_date]","value":"2020-12-12","description":"make sure type is custom_range"},{"key":"filter[end_date]","value":"2020-12-12","description":"make sure type is custom_range"},{"key":"filter[business_id]","value":"1"},{"key":"filter[type]","value":"today","description":"today, yesterday, last_7_days, last_30_days, this_month, last_month, custom_range"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"5b9fda78a825dc68d45b5cc34c991065\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"a965e62b-2daa-4bf9-af28-ca282e88983b"},{"key":"x-runtime","value":"0.146297"},{"key":"server-timing","value":"sql.active_record;dur=17.43, instantiation.active_record;dur=5.43, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.03, process_action.action_controller;dur=30.86"},{"key":"Content-Length","value":"84"}],"cookie":[],"responseTime":null,"body":"{\n \"total_businesses\": 3,\n \"total_calls\": 79,\n \"total_duration\": 11363,\n \"total_revenue\": 10000\n}"}],"_postman_id":"24c900ea-afcf-4f36-a245-bbe9da4e8a7e"},{"name":"breakdown","id":"2c424adc-bfff-4788-99f1-e3bee69f378c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/agency/usage/breakdown","description":"This endpoint retrieves a breakdown of agency usage based on specified filter parameters. It allows clients to obtain detailed metrics related to agency activities over a defined period.
\nmake sure type is custom_range
\n","type":"text/plain"},"key":"filter[start_date]","value":"2020-12-12"},{"disabled":true,"description":{"content":"make sure type is custom_range
\n","type":"text/plain"},"key":"filter[end_date]","value":"2020-12-12"},{"disabled":true,"key":"filter[business_id]","value":"1"},{"disabled":true,"description":{"content":"'today', 'yesterday', 'last_7_days', 'last_30_days', 'this_month', 'last_month', 'custom_range
\n","type":"text/plain"},"key":"filter[range_type]","value":"today"},{"disabled":true,"key":"filter[range_type]","value":"custom_range"}],"variable":[]}},"response":[{"id":"ade7ee12-806c-4d01-981c-b0ee224024f7","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/agency/usage/breakdown","host":["{{base_url}}"],"path":["api","v1","agency","usage","breakdown"],"query":[{"key":"filter[start_date]","value":"2020-12-12","description":"make sure type is custom_range","disabled":true},{"key":"filter[end_date]","value":"2020-12-12","description":"make sure type is custom_range","disabled":true},{"key":"filter[business_id]","value":"1","disabled":true},{"key":"filter[type]","value":"today","description":"today, yesterday, last_7_days, last_30_days, this_month, last_month, custom_range","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"db5628bd54d8a4f0bc0e9161a9c30ea2\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"961aa326-38ad-42b9-9c6c-831985a1f26f"},{"key":"x-runtime","value":"0.206763"},{"key":"server-timing","value":"sql.active_record;dur=18.52, instantiation.active_record;dur=14.96, start_processing.action_controller;dur=0.01, render.active_model_serializers;dur=0.06, process_action.action_controller;dur=53.90"},{"key":"Content-Length","value":"1469"}],"cookie":[],"responseTime":null,"body":"{\n \"date\": [\n {\n \"business_name\": \"Business\",\n \"agent_name\": \"Alex\",\n \"total_calls\": 1,\n \"call_duration\": 36,\n \"id\": null,\n \"total_revenue\": 100\n },\n {\n \"business_name\": \"Tech\",\n \"agent_name\": \"Milo\",\n \"total_calls\": 2,\n \"call_duration\": 74,\n \"id\": null,\n \"total_revenue\": 1000\n },\n {\n \"business_name\": \"Realters\",\n \"agent_name\": \"Ava\",\n \"total_calls\": 76,\n \"call_duration\": 11253,\n \"id\": null,\n \"total_revenue\": 10000\n }\n ],\n \"links\": {\n \"self\": \"http://api-kickcall.lvh.me:3000/api/v1/agency/usage/breakdown?filter[start_date]=2020-12-12&filter[end_date]=2020-12-12&filter[business_id]=1&filter[type]=today\",\n \"next\": \"http://api-kickcall.lvh.me:3000/api/v1/agency/usage/breakdown?filter%5Bbusiness_id%5D=1&filter%5Bend_date%5D=2020-12-12&filter%5Bstart_date%5D=2020-12-12&filter%5Btype%5D=today&page=1\",\n \"prev\": \"http://api-kickcall.lvh.me:3000/api/v1/agency/usage/breakdown?filter%5Bbusiness_id%5D=1&filter%5Bend_date%5D=2020-12-12&filter%5Bstart_date%5D=2020-12-12&filter%5Btype%5D=today&page=1\",\n \"last\": \"http://api-kickcall.lvh.me:3000/api/v1/agency/usage/breakdown?filter%5Bbusiness_id%5D=1&filter%5Bend_date%5D=2020-12-12&filter%5Bstart_date%5D=2020-12-12&filter%5Btype%5D=today&page=1\",\n \"first\": \"http://api-kickcall.lvh.me:3000/api/v1/agency/usage/breakdown?filter%5Bbusiness_id%5D=1&filter%5Bend_date%5D=2020-12-12&filter%5Bstart_date%5D=2020-12-12&filter%5Btype%5D=today&page=1\"\n },\n \"meta\": {\n \"count\": 3,\n \"total_count\": 3,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"2c424adc-bfff-4788-99f1-e3bee69f378c"},{"name":"export","id":"fe318103-a292-4a4e-89e9-54433db0ca68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"text/csv","type":"text"}],"url":"{{base_url}}/api/v1/agency/usage/export","description":"This endpoint allows users to export agency usage data based on specified date filters. The data can be filtered by a start date and an end date to retrieve records within that specific range.
\nUsage refers to the collection of key analytics and performance metrics that reflect how the agency and its associated businesses are interacting with the platform. It includes data such as call time, user activity, feature consumption, and other measurable events. These insights help evaluate engagement levels, resource utilization, and overall effectiveness of the agency’s operations.
\n","_postman_id":"9b8be272-d7a0-43c3-aac9-4d9cd365ecba"},{"name":"Available Integrations","item":[{"name":"index","id":"ad223a31-7ec4-4702-abde-dcef638b8e00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{api_key}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/agency/available_integrations/","description":"This endpoint retrieves a list of available integrations for the agency.
\nThis endpoint retrieves the available integrations for a specific agency identified by the id parameter.
Unique identifier for the available integration
\n","type":"text/plain"},"type":"any","value":"6","key":"id"}]}},"response":[{"id":"5ff5d081-70d2-4b76-b04d-c3d6e72f3926","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/agency/available_integrations/:id","host":["{{base_url}}"],"path":["api","v1","agency","available_integrations",":id"],"variable":[{"key":"id","value":"6","description":"Unique identifier for the available integration"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"2d7e733c318f86128ac031e626774098\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"83ce9c56-909d-4d28-9220-907646560253"},{"key":"x-runtime","value":"0.072693"},{"key":"server-timing","value":"sql.active_record;dur=27.40, instantiation.active_record;dur=0.81, start_processing.action_controller;dur=0.00, render.active_model_serializers;dur=36.56, process_action.action_controller;dur=39.18"},{"key":"Content-Length","value":"663"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"name\": \"MCP\",\n \"code\": \"mcp\",\n \"description\": \"MCP is a server management platform that provides centralized control, automation, and monitoring for infrastructure across data centers and cloud environments.\",\n \"category\": \"automation\",\n \"connection_type\": \"credentials\",\n \"small_avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6NDQsInB1ciI6ImJsb2JfaWQifX0=--f937355abe91b268a6c877ab5639ab573b5f9863/mcp_small.png\",\n \"avatar_url\": \"http://api-kickcall.lvh.me:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6NDMsInB1ciI6ImJsb2JfaWQifX0=--6116ac304b95f39819afb6f0b16e1a50c9da880a/mcp.png\",\n \"meta\": null\n}"}],"_postman_id":"9ebeeb61-5774-4460-83ff-b48a5a7903d8"}],"id":"e5d15df2-23bb-4cac-8542-c7cf20990ef9","description":"Available Integrations represent the set of predefined integrations that an agency allows its businesses to access or enable.
\nThe response will be in JSON format and includes the following structure:
\n","_postman_id":"e5d15df2-23bb-4cac-8542-c7cf20990ef9"}],"id":"9f36f175-4334-4d7f-ae86-600d0e0e2bac","description":"An Agency represents the top-level governing entity that manages and oversees multiple businesses within the platform. It defines global configurations, feature access, usage limits, and policies that apply to all businesses under its control.
\nThe platform is multi-tenant, where each agency is a logically isolated tenant. This means that data, configurations, and access are strictly separated between agencies, ensuring security and privacy across tenants.
\n","_postman_id":"9f36f175-4334-4d7f-ae86-600d0e0e2bac"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"7c6d335d-b5e3-44ba-8b33-9f1657c3f2a4"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"13f96bae-342d-48db-8723-50e0aa904136"}}]}