Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openmetadata-codex-audit-docs-codebase-alignment.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

https://mintcdn.com/openmetadata-codex-audit-docs-codebase-alignment/7qSJ5lAlGGoMt0gN/public/images/icons/python-sdk.svg?fit=max&auto=format&n=7qSJ5lAlGGoMt0gN&q=85&s=83e9b8c7fbecef18e260b6da5f337710

Python SDK

A high-level, type-safe Python API that smoothly integrates with the OpenMetadata backend.
https://mintcdn.com/openmetadata-codex-audit-docs-codebase-alignment/7qSJ5lAlGGoMt0gN/public/images/icons/java-sdk.svg?fit=max&auto=format&n=7qSJ5lAlGGoMt0gN&q=85&s=933d30f257fe2cb952902ac5fbd3f652

Java SDK

Integrate OpenMetadata into your Java environment to provision and manage resources.
https://mintcdn.com/openmetadata-codex-audit-docs-codebase-alignment/7qSJ5lAlGGoMt0gN/public/images/icons/go-sdk.svg?fit=max&auto=format&n=7qSJ5lAlGGoMt0gN&q=85&s=c04eee9d17723d8598bdad65fdc9be5d

Golang SDK

A robust, type-safe Go API that smoothly integrates with the OpenMetadata backend.

How to get the JWT Token

Bot Token

  1. Go to the settings page from the navbar and then scroll down to the Integrations Section. Click on the Bots and you will see the list of bots, then click on the ingestion-bot. bot-list
  2. You will be redirected to the ingestion-bot details page. there you will get the JWT token, click on the copy button and copy the JWT token. bot-token
  3. Optionally, You can create your own bot for specific use case.

User Token

  1. From 1.3.0 release onwards, we support User’s personal access token
  2. Go to logged in user profile by clicking on User’s profile image on top right corner. user-profile
  3. Click on Access Token tab, Generate a New token. user-profile
  • Alright, now you have the JWT token to use it with the SDKs below.