> For the complete documentation index, see [llms.txt](https://docs-en.dydu.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-en.dydu.ai/developers/api-reference.md).

# API reference

The Dydu APIs let you run your bot from your own interface, retrieve your data (dialogs, knowledge base) and automate some administration tasks.

### Before you start

To use most APIs, you need two things:

1. **Your bot identifier (botUUID)**: it is displayed on the **Preferences > Api > API access** page. See [Access to APIs](https://docs-en.dydu.ai/developers/api-reference/access-to-apis).
2. **An authorization**: a token to put in the `Authorization` header of your requests. See [Authentication](https://docs-en.dydu.ai/developers/api-reference/authentication).

In the examples of this section, replace `<server>` with the address of your platform (for example "app1.earth.doyoudreamup.com").

### Available APIs

<table data-search="false"><thead><tr><th>Page</th><th>What it is for</th></tr></thead><tbody><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/access-to-apis">Access to APIs</a></td><td>Find the bot identifier, open the Swagger interface and change the bot preferences.</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/authentication">Authentication</a></td><td>Build the <code>Authorization</code> header (Basic or Bearer).</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/dialog-api">Dialog API</a></td><td>Run dialogs with the bot from your application (<code>/api/chat</code> REST API and WebSocket).</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/search-field">Search field</a></td><td>Suggest knowledge while the user is typing a question.</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/dialogs-export">Dialogs Export</a></td><td>Export dialogs as XML, CSV or Excel.</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/import-export-knowledge-base">Import/Export Knowledge Base</a></td><td>Export, import or delete the knowledge base of a bot.</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/import-export-bot">Import Export Bot</a></td><td>Duplicate a whole bot, for example from production to staging.</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/user-management-in-the-bms">User Management in the BMS</a></td><td>Create or update BMS user accounts.</td></tr><tr><td><a href="https://docs-en.dydu.ai/developers/api-reference/server-status-api">Server Status API</a></td><td>Monitor the status of your platform.</td></tr></tbody></table>

{% hint style="info" %}
External NLP engines are configured in the BMS, from **Preferences > Api > External NLPs**: see the [External NLPs](https://docs-en.dydu.ai/preferences/api/external-nlps.md) page.
{% endhint %}
