Skip to main content

Integrations

Beak AI Studio supports integration with a wide range of external systems, data sources, and APIs to enhance agent capabilities and workflows.

Supported Integration Types​

  • Databases: Connect to SQL (Postgres, MySQL, SQLite) and NoSQL (MongoDB, Redis) databases.
  • Files: Ingest data from CSV, JSON, Excel, and other file formats.
  • Web APIs: Integrate RESTful APIs for real-time or batch data access.
  • Cloud Storage: Connect to AWS S3, Azure Blob, Google Cloud Storage, and more.
  • Internal Services: Use custom connectors for proprietary or internal systems.

How to Integrate​

1. Add a Data Source​

  • Go to the "Data Sources" tab in Studio.
  • Click "Add Data Source" and select the type (database, file, API, etc.).
  • Enter connection details and credentials.
  • Test the connection and save.

2. Register an API Integration​

  • In the "Skills" section, create a new REST API skill by providing a name, description, and usage instructions.
  • When adding the skill to an agent, click "Configure" to upload the OpenAPI specification and supply any required authentication details.
  • Use the skill in agent workflows.

3. Use Pre-Built and Custom Skills​

  • Leverage pre-built skills for common integrations (search, summarization, etc.).
  • Build custom skills (Python, REST API, or LLM Prompt) for unique requirements using the streamlined two-step workflow.

Best Practices​

  • Store credentials securely using environment variables or secrets management.
  • Monitor integration health in Observability.
  • Document all custom integrations for maintainability.

For advanced integration scenarios, see the Customizing Skills Guide and Data Sources Documentation.​

Microsoft Teams & Microsoft Copilot Ecosystem​

Enable multi-user, collaborative conversational UI and integrate AI agents across the Microsoft Teams and Microsoft Copilot ecosystem.

  • Setup: Deploy the Beak AI Teams App using the provided manifest or connect via the Teams integration wizard. For Copilot, follow guidelines to register and surface Beak AI agents as Copilot plugins or skills within Microsoft 365 applications.
  • Features: Real-time AI chat, shared agent contexts, collaborative knowledge work, cross-organization access in Teams channels, and task automation within Microsoft 365 (Word, Outlook, Excel, etc.) via Copilot.
  • Scenarios: Shared troubleshooting sessions, cross-function support bots, conversational analytics dashboards, and agent-powered productivity workflows directly inside Microsoft 365 applications.

Copilot Agent Interface​

Embed Beak AI agents as copilots inside enterprise web apps and workflow tools.

  • Setup: Use the Copilot integration snippet from the "Deploy" panel in Studio, and embed it in your internal app.
  • Capabilities: Conversational Q&A, inline recommendations, data lookups, workflow automation within any SaaS or intranet software.

Webhook Integration Support​

Trigger agent workflows or actions in response to external system events.

  • Setup: In "Integrations," configure a webhook, specify the agent/action to trigger and endpoint.
  • Usage: Use webhooks to ingest alerts, synchronize status, or automate actions based on CRM, ticketing system, or CI/CD changes.

User API Key Generation​

Generate isolated API keys for user, team, or integration-based access.

  • Setup: Go to "My Profile" / "API Keys" or the "Admin" tab, click "Generate API Key," assign scopes (read, write, agent, etc.), and use the token in REST/SDK calls.
  • Security: All keys are encrypted, scoped to entities, and rotated/minimized according to best practices.
  • Use cases: Automating extraction/ingestion flows, integrating Beak AI Studio with external automations/apps.