SDK & API
OpenMetadata API
To access OpenMetadata APIs, one needs a token to authenticate and authorize API calls.Access the OpenAPI (Swagger) documentation at OpenMetadata API.Client SDKs
Python SDK
A high-level, type-safe Python API that smoothly integrates with the OpenMetadata backend.
Java SDK
Integrate OpenMetadata into your Java environment to provision and manage resources.
Golang SDK
A robust, type-safe Go API that smoothly integrates with the OpenMetadata backend.
How to get the JWT Token
Bot Token
Bot tokens are ideal for automated processes, integrations, and programmatic access. Choose the appropriate bot based on your use case:Data Ingestion & Processing
- IngestionBot: For metadata ingestion and connector workflows
- LineageBot: For ingesting lineage metadata
- ProfilerBot: For ingesting profiling and sample data
- UsageBot: For ingesting usage metadata
- TestSuiteBot: For ingesting data quality tests
AI & Automation
- McpApplicationBot: For Model Context Protocol (MCP) integrations with AI assistants (Cursor, Claude, etc.)
Data Quality & Governance
- AutoClassificationBot: For automatic PII classification and sample data ingestion
System & Integration
- MetadataExporterApplicationBot: For metadata export operations
- SCIM Bot: For SCIM-only access and user provisioning
-
Go to the Settings page from the navbar and scroll down to the Integrations section. Click on Bots to see the list of available bots.
-
Select the bot that matches your use case from the categories above. You’ll be redirected to the bot’s details page where you can view and copy the JWT token.
- Optionally, you can create your own custom bot for specific use cases with tailored permissions and access controls.
User Token
- From 1.3.0 release onwards, we support User’s personal access token
-
Go to logged in user profile by clicking on User’s profile image on top right corner.
-
Click on Access Token tab, Generate a New token.
- Alright, now you have the JWT token to use it with the SDKs below.