# Robofy API ## Docs - Root [Overview](https://docs.robofy.ai/overview-365466m0.md): - Root [Architecture](https://docs.robofy.ai/architecture-365465m0.md): - Root [Authentication](https://docs.robofy.ai/authentication-364575m0.md): - Root [Changelog](https://docs.robofy.ai/changelog-364577m0.md): ## API Docs - Root > Chat [Generate Client Token (Handshake)](https://docs.robofy.ai/generate-client-token-handshake-4285641e0.md): Initializes the Robofy widget and returns the widget configuration, available chatbot agents, and an authorization token for further widget communication. - Root > Chat [Send Message (Streaming)](https://docs.robofy.ai/send-message-streaming-4285640e0.md): Send Message (Streaming) allows a client application to send a user message to an AI agent and receive an AI-generated response as a stream. - Root > Chat [Send Message (Non Streaming)](https://docs.robofy.ai/send-message-non-streaming-4285589e0.md): Send Message (Non Streaming) allows a client application to send a user message to an AI agent and receive a complete AI-generated response in a single request. - Root > Chat [Send WhatsApp Message](https://docs.robofy.ai/send-whatsapp-message-4285642e0.md): Send WhatsApp Message allows a client application to send a WhatsApp user message to an AI agent and receive a complete AI-generated response in a single request. - Root > Chatbot / Agent [List Agents](https://docs.robofy.ai/list-agents-4263861e0.md): Retrieves the list of chatbot agents available under the specified project. This endpoint returns basic details for each chatbot, including its name, description, type, access level, avatar URL, LLM source, language, readiness status, file usage, link usage, storage size, and timestamps. - Root > Chatbot / Agent [Create Agent](https://docs.robofy.ai/create-agent-4263862e0.md): Create Agent allows you to create a new AI chatbot agent inside a specific project. - Root > Chatbot / Agent [Retrieve Agent](https://docs.robofy.ai/retrieve-agent-4263863e0.md): Retrieves the details of a specific chatbot agent within a project. This endpoint returns the chatbot configuration and status information, including its name, description, type, access level, avatar URL, LLM source, language, readiness status, resource usage, and timestamps. - Root > Chatbot / Agent [Update Agent](https://docs.robofy.ai/update-agent-4263864e0.md): - Root > Chatbot / Agent [Delete Agent](https://docs.robofy.ai/delete-agent-4263865e0.md): - Root > Chatbot / Agent [Delink Asset ](https://docs.robofy.ai/delink-asset-4263866e0.md): Removes the link between a chatbot and an existing knowledge asset. This endpoint does not necessarily delete the original asset from storage. It only detaches the asset from the chatbot so the chatbot no longer uses it as a knowledge source. - Root > Chatbot / Agent [List Linked Assets](https://docs.robofy.ai/list-linked-assets-4263867e0.md): Retrieves a paginated list of assets linked to a specific chatbot agent. Linked assets can be uploaded files or website URLs that are used as knowledge sources for the chatbot. - Root > Chatbot / Agent [Delete Widget Tab](https://docs.robofy.ai/delete-widget-tab-4263868e0.md): - Root > Account [Retrieve Account Details ](https://docs.robofy.ai/retrieve-account-details-4263849e0.md): - Root > Account [Update Account Details](https://docs.robofy.ai/update-account-details-4263850e0.md): - Root > Account [Retrieve Account Limit](https://docs.robofy.ai/retrieve-account-limit-4263851e0.md): - Root > Prompt & Persona [Update System Prompt](https://docs.robofy.ai/update-system-prompt-4295154e0.md): Updates the AI configuration system prompt settings for a specific chatbot. - Root > Prompt & Persona [Retrieve Agent Settings](https://docs.robofy.ai/retrieve-agent-settings-4295186e0.md): - Root > Prompt & Persona [Update Persona](https://docs.robofy.ai/update-persona-4295547e0.md): This API updates the persona configuration of an AI agent. - Root > Prompt & Persona [Retrieve Persona](https://docs.robofy.ai/retrieve-persona-4295548e0.md): - Root > Inbox [List Sessions](https://docs.robofy.ai/list-sessions-4263878e0.md): - Root > Inbox [List Session Messages](https://docs.robofy.ai/list-session-messages-4263879e0.md): - Root > Project [Create Project](https://docs.robofy.ai/create-project-4263904e0.md): - Root > Project [List Projects](https://docs.robofy.ai/list-projects-4263905e0.md): - Root > Project [Update Project](https://docs.robofy.ai/update-project-4263906e0.md): - Root > Project [Retreive Project](https://docs.robofy.ai/retreive-project-4263907e0.md): - Root > Leads [List Leads](https://docs.robofy.ai/list-leads-4263858e0.md): - Root > Content [Add Website](https://docs.robofy.ai/add-website-4263885e0.md): Add Website allows you to crawl website pages and link the crawled content with a chatbot as a knowledge source. - Root > Content [Get Crawl Status](https://docs.robofy.ai/get-crawl-status-4263886e0.md): - Root > Content [Add Text Content](https://docs.robofy.ai/add-text-content-4263887e0.md): Add Text Content allows you to add custom text content and link it with a chatbot as a knowledge asset. - Root > Content [Add File](https://docs.robofy.ai/add-file-4314729e0.md): Add File API allows you to upload a file as a project asset and optionally link it with an AI Agent. - Root > Stats [Stats](https://docs.robofy.ai/stats-4263859e0.md): - Root > License [Create License](https://docs.robofy.ai/create-license-4263897e0.md): - Root > License [List License](https://docs.robofy.ai/list-license-4263898e0.md): - Root > License [Update License](https://docs.robofy.ai/update-license-4263899e0.md): - Root > License [Retrieve License](https://docs.robofy.ai/retrieve-license-4263900e0.md): - Root > License [Delete License](https://docs.robofy.ai/delete-license-4263901e0.md): - Root > License [Update License Limit](https://docs.robofy.ai/update-license-limit-4263902e0.md): - Root > Partner [Onboard](https://docs.robofy.ai/onboard-4263903e0.md): ## Schemas - Root [Account](https://docs.robofy.ai/account-823600d0.md): - Root [AccountDetailDto](https://docs.robofy.ai/accountdetaildto-823601d0.md): - Root [Address](https://docs.robofy.ai/address-823602d0.md): - Root [AgentCredentialInsertResponseDto](https://docs.robofy.ai/agentcredentialinsertresponsedto-823603d0.md): - Root [AgentCredentialRequestDto](https://docs.robofy.ai/agentcredentialrequestdto-823604d0.md): - Root [AgentCredentialResponseDto](https://docs.robofy.ai/agentcredentialresponsedto-823605d0.md): - Root [AgentDataPoint](https://docs.robofy.ai/agentdatapoint-823606d0.md): - Root [AgentLeadCapture](https://docs.robofy.ai/agentleadcapture-823607d0.md): - Root [AgentLeadReportDto](https://docs.robofy.ai/agentleadreportdto-823608d0.md): - Root [AgentLinkageDto](https://docs.robofy.ai/agentlinkagedto-823609d0.md): - Root [AgentMcpServerDto](https://docs.robofy.ai/agentmcpserverdto-823610d0.md): - Root [AgentMcpServerInsertResponseDto](https://docs.robofy.ai/agentmcpserverinsertresponsedto-823611d0.md): - Root [AgentMcpServerRequestDto](https://docs.robofy.ai/agentmcpserverrequestdto-823612d0.md): - Root [AgentMcpServerUpdateRequestDto](https://docs.robofy.ai/agentmcpserverupdaterequestdto-823613d0.md): - Root [AgentPromptVersionDto](https://docs.robofy.ai/agentpromptversiondto-823614d0.md): - Root [AgentSessionListDto](https://docs.robofy.ai/agentsessionlistdto-823615d0.md): - Root [AgentSessionListItemDto](https://docs.robofy.ai/agentsessionlistitemdto-823616d0.md): - Root [AgentStatsDto](https://docs.robofy.ai/agentstatsdto-823617d0.md): - Root [AgentThemeDto](https://docs.robofy.ai/agentthemedto-823618d0.md): - Root [AgentThemeListDto](https://docs.robofy.ai/agentthemelistdto-823619d0.md): - Root [AgentToolLinkageInsertResponseDto](https://docs.robofy.ai/agenttoollinkageinsertresponsedto-823620d0.md): - Root [AgentToolLinkageRequestDto](https://docs.robofy.ai/agenttoollinkagerequestdto-823621d0.md): - Root [AgentWhatappIntrgrationResponse](https://docs.robofy.ai/agentwhatappintrgrationresponse-823622d0.md): - Root [AgentWhatsAppLinkageDto](https://docs.robofy.ai/agentwhatsapplinkagedto-823623d0.md): - Root [Button](https://docs.robofy.ai/button-823624d0.md): - Root [CarouselCard](https://docs.robofy.ai/carouselcard-823625d0.md): - Root [CategoryStats](https://docs.robofy.ai/categorystats-823626d0.md): - Root [ChatBotDetailsDto](https://docs.robofy.ai/chatbotdetailsdto-823627d0.md): - Root [ChatBotDetailsRequest](https://docs.robofy.ai/chatbotdetailsrequest-823628d0.md): - Root [ChatBotDetailsUpdateRequest](https://docs.robofy.ai/chatbotdetailsupdaterequest-823629d0.md): - Root [ChatbotAISettingsDto](https://docs.robofy.ai/chatbotaisettingsdto-823630d0.md): - Root [ChatbotAISettingsRequest](https://docs.robofy.ai/chatbotaisettingsrequest-823631d0.md): - Root [ChatbotAdvanceSettingsDto](https://docs.robofy.ai/chatbotadvancesettingsdto-823632d0.md): - Root [ChatbotAdvanceSettingsRequest](https://docs.robofy.ai/chatbotadvancesettingsrequest-823633d0.md): - Root [ChatbotAppearanceSettingsDto](https://docs.robofy.ai/chatbotappearancesettingsdto-823634d0.md): - Root [ChatbotAppearanceSettingsRequest](https://docs.robofy.ai/chatbotappearancesettingsrequest-823635d0.md): - Root [ChatbotAssetDelinkDto](https://docs.robofy.ai/chatbotassetdelinkdto-823636d0.md): - Root [ChatbotAssetLinkageDataDto](https://docs.robofy.ai/chatbotassetlinkagedatadto-823637d0.md): - Root [ChatbotAssetLinkageDelinkRequest](https://docs.robofy.ai/chatbotassetlinkagedelinkrequest-823638d0.md): - Root [ChatbotAssetLinkageDetailsDto](https://docs.robofy.ai/chatbotassetlinkagedetailsdto-823639d0.md): - Root [ChatbotAssetLinkageDto](https://docs.robofy.ai/chatbotassetlinkagedto-823640d0.md): - Root [ChatbotAssetLinkageRequest](https://docs.robofy.ai/chatbotassetlinkagerequest-823641d0.md): - Root [ChatbotTextLinkageRequest](https://docs.robofy.ai/chatbottextlinkagerequest-823642d0.md): - Root [ClientData](https://docs.robofy.ai/clientdata-823643d0.md): - Root [CommonResponse](https://docs.robofy.ai/commonresponse-823644d0.md): - Root [Component](https://docs.robofy.ai/component-823645d0.md): - Root [Contact](https://docs.robofy.ai/contact-823646d0.md): - Root [ContactName](https://docs.robofy.ai/contactname-823647d0.md): - Root [CrawlStatusDto](https://docs.robofy.ai/crawlstatusdto-823648d0.md): - Root [CrawlWebsiteRequest](https://docs.robofy.ai/crawlwebsiterequest-823649d0.md): - Root [CreateOrUpdateProjectRequest](https://docs.robofy.ai/createorupdateprojectrequest-823650d0.md): - Root [CreatePhoneNumberRequest](https://docs.robofy.ai/createphonenumberrequest-823651d0.md): - Root [CreateTemplateRequest](https://docs.robofy.ai/createtemplaterequest-823652d0.md): - Root [CreateWebhookConfigRequest](https://docs.robofy.ai/createwebhookconfigrequest-823653d0.md): - Root [DeLinkWhatsAppRequest](https://docs.robofy.ai/delinkwhatsapprequest-823654d0.md): - Root [Email](https://docs.robofy.ai/email-823655d0.md): - Root [Error](https://docs.robofy.ai/error-823656d0.md): - Root [ErrorResponse](https://docs.robofy.ai/errorresponse-823657d0.md): - Root [Example](https://docs.robofy.ai/example-823658d0.md): - Root [FailureStats](https://docs.robofy.ai/failurestats-823659d0.md): - Root [FailureStatsDataPoint](https://docs.robofy.ai/failurestatsdatapoint-823660d0.md): - Root [FormField](https://docs.robofy.ai/formfield-823661d0.md): - Root [GoogleSheetDto](https://docs.robofy.ai/googlesheetdto-823662d0.md): - Root [GoogleSheetIntegrationRequest](https://docs.robofy.ai/googlesheetintegrationrequest-823663d0.md): - Root [InboxChatDto](https://docs.robofy.ai/inboxchatdto-823664d0.md): - Root [InboxDto](https://docs.robofy.ai/inboxdto-823665d0.md): - Root [InboxMessage](https://docs.robofy.ai/inboxmessage-823666d0.md): - Root [InboxSession](https://docs.robofy.ai/inboxsession-823667d0.md): - Root [IntelligentMetricsDto](https://docs.robofy.ai/intelligentmetricsdto-823668d0.md): - Root [Interactive](https://docs.robofy.ai/interactive-823669d0.md): - Root [InteractiveAction](https://docs.robofy.ai/interactiveaction-823670d0.md): - Root [InteractiveBody](https://docs.robofy.ai/interactivebody-823671d0.md): - Root [InteractiveButton](https://docs.robofy.ai/interactivebutton-823672d0.md): - Root [InteractiveFooter](https://docs.robofy.ai/interactivefooter-823673d0.md): - Root [InteractiveHeader](https://docs.robofy.ai/interactiveheader-823674d0.md): - Root [InteractiveMedia](https://docs.robofy.ai/interactivemedia-823675d0.md): - Root [InteractiveProductItem](https://docs.robofy.ai/interactiveproductitem-823676d0.md): - Root [InteractiveProductSection](https://docs.robofy.ai/interactiveproductsection-823677d0.md): - Root [InteractiveReply](https://docs.robofy.ai/interactivereply-823678d0.md): - Root [InteractiveRow](https://docs.robofy.ai/interactiverow-823679d0.md): - Root [InteractiveSection](https://docs.robofy.ai/interactivesection-823680d0.md): - Root [LeadCaptureForm](https://docs.robofy.ai/leadcaptureform-823681d0.md): - Root [LeadData](https://docs.robofy.ai/leaddata-823682d0.md): - Root [LeadDataField](https://docs.robofy.ai/leaddatafield-823683d0.md): - Root [LeadFormData](https://docs.robofy.ai/leadformdata-823684d0.md): - Root [LeadReport](https://docs.robofy.ai/leadreport-823685d0.md): - Root [LicenseCreateRequest](https://docs.robofy.ai/licensecreaterequest-823686d0.md): - Root [LicenseDto](https://docs.robofy.ai/licensedto-823687d0.md): - Root [LicenseLimitRequest](https://docs.robofy.ai/licenselimitrequest-823688d0.md): - Root [LicenseUpdateRequest](https://docs.robofy.ai/licenseupdaterequest-823689d0.md): - Root [LimitedTimeOffer](https://docs.robofy.ai/limitedtimeoffer-823690d0.md): - Root [LinkWhatsAppRequest](https://docs.robofy.ai/linkwhatsapprequest-823691d0.md): - Root [LinkedCredentialDto](https://docs.robofy.ai/linkedcredentialdto-823692d0.md): - Root [LinkedMcpServerDto](https://docs.robofy.ai/linkedmcpserverdto-823693d0.md): - Root [Location](https://docs.robofy.ai/location-823694d0.md): - Root [Media](https://docs.robofy.ai/media-823695d0.md): - Root [MessageMetaData](https://docs.robofy.ai/messagemetadata-823696d0.md): - Root [MessageRequest](https://docs.robofy.ai/messagerequest-823697d0.md): - Root [MessageResponse](https://docs.robofy.ai/messageresponse-823698d0.md): - Root [MessageStats](https://docs.robofy.ai/messagestats-823699d0.md): - Root [MessageStatsDataPoint](https://docs.robofy.ai/messagestatsdatapoint-823700d0.md): - Root [MessageTemplate](https://docs.robofy.ai/messagetemplate-823701d0.md): - Root [NamedParameter](https://docs.robofy.ai/namedparameter-823702d0.md): - Root [OrgLimitDto](https://docs.robofy.ai/orglimitdto-823703d0.md): - Root [Organization](https://docs.robofy.ai/organization-823704d0.md): - Root [PaginatedWebhookLogsResponse](https://docs.robofy.ai/paginatedwebhooklogsresponse-823705d0.md): - Root [Part](https://docs.robofy.ai/part-823706d0.md): - Root [PartnerClientSession](https://docs.robofy.ai/partnerclientsession-823707d0.md): - Root [PartnerClientSessionDto](https://docs.robofy.ai/partnerclientsessiondto-823708d0.md): - Root [Phone](https://docs.robofy.ai/phone-823709d0.md): - Root [PhoneNumberRequest](https://docs.robofy.ai/phonenumberrequest-823710d0.md): - Root [PhoneVerifyCodeRequest](https://docs.robofy.ai/phoneverifycoderequest-823711d0.md): - Root [PhoneVerifyRequest](https://docs.robofy.ai/phoneverifyrequest-823712d0.md): - Root [PlatformStats](https://docs.robofy.ai/platformstats-823713d0.md): - Root [ProjectDetailDto](https://docs.robofy.ai/projectdetaildto-823714d0.md): - Root [ProjectWABADetail](https://docs.robofy.ai/projectwabadetail-823715d0.md): - Root [Reaction](https://docs.robofy.ai/reaction-823716d0.md): - Root [ReadTypingIndicatorRequest](https://docs.robofy.ai/readtypingindicatorrequest-823717d0.md): - Root [RecentInsightDto](https://docs.robofy.ai/recentinsightdto-823718d0.md): - Root [Response](https://docs.robofy.ai/response-823719d0.md): - Root [SessionInsightItemDto](https://docs.robofy.ai/sessioninsightitemdto-823720d0.md): - Root [SessionInsightsDto](https://docs.robofy.ai/sessioninsightsdto-823721d0.md): - Root [SessionMetaDto](https://docs.robofy.ai/sessionmetadto-823722d0.md): - Root [SessionMetricsDto](https://docs.robofy.ai/sessionmetricsdto-823723d0.md): - Root [SessionSummaryDetailDto](https://docs.robofy.ai/sessionsummarydetaildto-823724d0.md): - Root [StartUrl](https://docs.robofy.ai/starturl-823725d0.md): - Root [SubcribedAppsRequest](https://docs.robofy.ai/subcribedappsrequest-823726d0.md): - Root [SupportedApp](https://docs.robofy.ai/supportedapp-823727d0.md): - Root [TemplateAction](https://docs.robofy.ai/templateaction-823728d0.md): - Root [TemplateButtons](https://docs.robofy.ai/templatebuttons-823729d0.md): - Root [TemplateCarousel](https://docs.robofy.ai/templatecarousel-823730d0.md): - Root [TemplateComponent](https://docs.robofy.ai/templatecomponent-823731d0.md): - Root [TemplateCurrency](https://docs.robofy.ai/templatecurrency-823732d0.md): - Root [TemplateDateTime](https://docs.robofy.ai/templatedatetime-823733d0.md): - Root [TemplateLimitedTimeOffer](https://docs.robofy.ai/templatelimitedtimeoffer-823734d0.md): - Root [TemplateMedia](https://docs.robofy.ai/templatemedia-823735d0.md): - Root [TemplateParameter](https://docs.robofy.ai/templateparameter-823736d0.md): - Root [TemplateProductItem](https://docs.robofy.ai/templateproductitem-823737d0.md): - Root [TemplateSection](https://docs.robofy.ai/templatesection-823738d0.md): - Root [TemplateTapTargetConfiguration](https://docs.robofy.ai/templatetaptargetconfiguration-823739d0.md): - Root [Text](https://docs.robofy.ai/text-823740d0.md): - Root [ThemeMetaDto](https://docs.robofy.ai/thememetadto-823741d0.md): - Root [TypingIndicator](https://docs.robofy.ai/typingindicator-823742d0.md): - Root [UpdateOnboardStatusRequest](https://docs.robofy.ai/updateonboardstatusrequest-823743d0.md): - Root [UpdateOnboardStatusResponseDto](https://docs.robofy.ai/updateonboardstatusresponsedto-823744d0.md): - Root [UploadMedia](https://docs.robofy.ai/uploadmedia-823745d0.md): - Root [Url](https://docs.robofy.ai/url-823746d0.md): - Root [WABADetail](https://docs.robofy.ai/wabadetail-823747d0.md): - Root [WABADto](https://docs.robofy.ai/wabadto-823748d0.md): - Root [Webhook](https://docs.robofy.ai/webhook-823749d0.md): - Root [WebhookConfigDto](https://docs.robofy.ai/webhookconfigdto-823750d0.md): - Root [WebhookConfiguration](https://docs.robofy.ai/webhookconfiguration-823751d0.md): - Root [WebhookLogDto](https://docs.robofy.ai/webhooklogdto-823752d0.md): - Root [WebsiteDto](https://docs.robofy.ai/websitedto-823753d0.md): - Root [WhatsAppBusinessApiData](https://docs.robofy.ai/whatsappbusinessapidata-823754d0.md): - Root [WhatsAppBusinessProfile](https://docs.robofy.ai/whatsappbusinessprofile-823755d0.md): - Root [WidgetIntegration](https://docs.robofy.ai/widgetintegration-823756d0.md):