# API DOCS - [Overview](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/overview.md) - [API Guidelines](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines.md): This section covers important information needed to configure and integrate third party services to Syntphony CAI. - [Conversation API](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/creating-channels-the-conversation-api.md): How to integrate own channels and custom interfaces in Syntphony CAI - [Cloner API](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/cloner.md): How to export or import the Bot structure, including various kinds of information, such as: Basic Bot Data, Intentions, Entity, Registered Flows, Channels and etc - [Management API](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api.md): The Management API allows you to fully integrate all functions within the Syntphony CAI's Cockpit into your own service or system, seamlessly integrating Syntphony CAI's system within your solution. - [Admin API](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/admin-api.md) - [Bot Admin](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/admin-api/bot-admin.md): The Bot Admin API handles a universal lookup and the relations of Virtual Agents across all environments. - [Environment](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/admin-api/environment.md): The Environment API alows you to retrieve information about Environments within an organization. - [Organization](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/admin-api/organization.md): The Organization API helps you acquire information from your organizations, and your client credentials. - [User](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/admin-api/user.md): The User API allows you to search, create and edit existing users, as well as set their user configuration values. - [Notification](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/admin-api/notification.md): The Notification API helps you acquire notifications to your user and mark as read - [Instance API](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api.md) - [Agent](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/agent.md): The Agent API handles methods to create and manage each agent and its relations of a Virtual Agent. - [Knowledge AI](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/knowledge-ai.md): The Knowledge AI (former Automated Learning) API contains methods for both it's related models: Documents, which contains the text to perform them, and Questions, which are assigned to Documents. - [Knowledge AI NLP](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/knowledge-ai-nlp.md): This API supplies a single endpoint which allows you to perform conversations through the Knowledge AI (Automated Learning) for simulations. - [Answer](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/answer.md): Answers are what we return when the conversation API identifies what the user's request are, according to our dialog manager. - [Automated Tests](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/automated-tests.md): The Automated Tests API contains all methods related to all models used in Automated Tests. - [Bot](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/bot.md): Bots are your Virtual Agents. - [Broker](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/broker.md): Further described at the Conversation API section, those are the methods used on conversation. - [Channel](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/channel.md): The Channel API handles methods to create and manage each Channel of a Virtual Agent. - [Dashboard](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/dashboard.md): The Dashboard API handles large data for the purpose of customer usage analytics. - [Dialog Manager](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/dialog-manager.md): The Dialog Manager is where you configure and draw your flows; Those are the methods you'll need to setup a user flow, configure each Cell and link them. - [Entity](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/entity.md): The Entity API handle the CRUD operations for Entities, System Entities, and also an auxiliary method for the Dialog Manager. - [Generative Service](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/generative-service.md): The Generative Service API handles all integration with LLMs and generative content. - [Intent](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/intent.md): The Intent API handles Intents and their utterances, also handling their mass import through files, known as Bulk Training. - [Parameters](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/parameters.md): The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally. - [Tag](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/tag.md): The tag API handles searching with tags - [Technical Log](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/technical-log.md): The technical log API handles showing the logs from one conversation inside bot simulator - [Training](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/training.md): The training API handles all training methods for bots that both use AL or not. - [Transactional Service](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/transactional-service.md): The Transactional Service API handles all transactional services used in your flows. - [Rest Connector](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/rest-connector.md): The Rest Connector API handles all rest connectors used in your flows. They share the transactional service subpath. - [Wait Input](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/wait-input.md): The Wait input API handles your Wait input Cells found in your flows. - [Websnippet](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/websnippet.md): The Web API handles you conversation with websnippet. - [Webhooks](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/webhooks.md): This section explains each of the webhooks that can be declared within the Cockpit to improve the user experience and give the user a customized conversation for his needs - [Infrastructure Guidelines](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/infrastructure-guidelines.md): This section covers important information needed to configure and install Syntphony CAI - [Syntphony CAI server Installation guide](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/infrastructure-guidelines/syntphony-cai-server-installation-guide.md) - [Maintenance Methods](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/infrastructure-guidelines/maintenance-methods.md): Eva-server installations will find the need for some managing methods. Those are listed below. - [Supported/verified third-party software](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/infrastructure-guidelines/supported-verified-third-party-software.md): Table of third-party software versions supported by Syntphony CAI in the version 4.0, a technical documentation for your interest - [Data Structure](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/appendices.md): This section covers information needed to understand Syntphony CAI's data structure and how to extract useful data. Data is split between distinct schemas: 2 in admin and 1 in environment. - [Admin Data Structure](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/appendices/admin-data-structure.md) - [Environment Data Structure](https://docs.conversational-ai.syntphony.com/user-guide/api-docs/appendices/environment-data-structure.md): Each environment has all their data contained within their own, isolated database structure --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.conversational-ai.syntphony.com/user-guide/api-docs.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.