Skip to main content

​
AI SDK

The AI SDK gives you programmatic access to OpenMetadata through two complementary paths: MCP Tools for building custom AI applications with any LLM, and AI Studio Agents for invoking ready-to-use AI assistants directly from your code.

Invoke Agent

Send a message to an AI Studio Agent and get a response, with optional streaming and multi-turn conversations.

Create Agent

Programmatically create an AI Studio Agent with a persona, abilities, and API access.

Create Persona

Create and manage personas that define the behavior and personality of AI Studio Agents.

MCP Tools

Use OpenMetadata’s MCP tools to give any LLM access to your metadata through search, lineage, glossary, and entity operations.

​
Available SDKs

SDKPackageInstall
Pythondata-ai-sdkpip install data-ai-sdk
TypeScript@openmetadata/ai-sdknpm install @openmetadata/ai-sdk
Javaorg.open-metadata:ai-sdkMaven / Gradle
CLIai-sdkInstall script

​
Prerequisites

You need:
  1. An OpenMetadata instance with AI Studio Agents enabled
  2. A Bot JWT token for API authentication
To get a JWT token, go to Settings > Bots in your OpenMetadata instance, select your bot, and copy the token.

​
Configuration

Set the following environment variables: 
export AI_SDK_HOST="https://your-org.getcollate.io"
export AI_SDK_TOKEN="your-bot-jwt-token"
All environment variables:
VariableRequiredDefaultDescription
AI_SDK_HOSTYes-Your OpenMetadata server URL
AI_SDK_TOKENYes-Bot JWT token
AI_SDK_TIMEOUTNo120Request timeout in seconds
AI_SDK_VERIFY_SSLNotrueVerify SSL certificates
AI_SDK_MAX_RETRIESNo3Number of retry attempts
AI_SDK_RETRY_DELAYNo1.0Base delay between retries (seconds)
You can find the source code for the AI SDK in the GitHub repository. Contributions are always welcome!