Getting Started
1. Create an App
- Select New or + Create App from the App dropdown.
- Enter an App Name.
- A Client ID and Client Secret are automatically generated for authenticating API requests.
2. Assign API Scopes
Select the scopes that match the features your app needs to access.Supported API Scopes
| API Scope | Description |
|---|---|
| IntentIdentification | Detect intents and entities from an utterance via a secured API |
| BotDefinition | Create, export, and import bots |
| BatchTest | Execute and manage Batch Test Suites, including running tests and retrieving results |
| BotPublish | Publish bots for deployment |
| TestAndTrain | Train ML models, manage FAQs, import/export utterances |
| Logs | Retrieve bot audit and admin console logs |
| GenAILLMUsageLogs | Retrieve GenAI and LLM usage logs |
| ProfileManagement | Manage roles and delete user data |
| BotAnalytics | Retrieve chat history and conversation sessions |
| UserManagement | Manage users |
| CustomReports | Fetch data for custom widgets and reports |
| ManageKnowledgeGraph | Manage and export knowledge graph definitions |
| ChannelManagement | Create and update communication channels |
| BotKit | Configure botkits and agent transfers |
| MasterAdmin | View and use sample bots |
| Processflow | Execute Process Apps via secure APIs |
| ProcessDefinition | Import, export, and list Process Apps |
| ProcessPublish | Publish Process Apps via API |
| ProcessLogs | Retrieve audit logs for Process App executions |
| LanguageSettings | Enable/disable languages, update settings, change default language |
| ConversationTests | Manage and execute conversation test suites |
| FileAccess | Retrieve download URLs for uploaded files |
| Answers | Full control over Search AI — answer generation, feedback, data ingestion, facets, chunks, highlights, and document/permission entities |
Once configured, apps can be used from within the Bot Builder Platform or externally via the platform’s public APIs. For the complete API list, see the API Reference.