# OpenMetadata Documentation: v1.13.x SDK & APIs ## SDK & APIs ### API Reference - [OpenMetadata SDKs & APIs](https://docs.open-metadata.org/v1.13.x/api-reference.md): Programmatic access to your OpenMetadata data catalog through REST APIs and native SDKs - [Getting Started](https://docs.open-metadata.org/v1.13.x/api-reference/getting-started.md): Set up your environment and make your first API call in minutes - [Authentication](https://docs.open-metadata.org/v1.13.x/api-reference/authentication.md): Authenticate your API requests using JWT Bearer tokens - [Errors](https://docs.open-metadata.org/v1.13.x/api-reference/errors.md): Understanding and handling OpenMetadata API errors - [Pagination](https://docs.open-metadata.org/v1.13.x/api-reference/pagination.md): Navigate through large result sets using cursor-based and offset-based pagination ### Data Assets - [Data Assets](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets.md): APIs for managing data assets across your metadata catalog - [Databases](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases-overview.md): API reference for the database hierarchy — services, databases, schemas, tables, and stored procedures #### Api Collections - [API Collections](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections.md): Create and manage API collections within an API service - [Create an API Collection](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections/create.md): Create a new API collection within an API service - [Delete an API Collection](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections/delete.md): Delete an API collection by ID or name, with soft/hard delete options - [List API Collections](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections/list.md): List all API collections with optional filtering and pagination - [Retrieve an API Collection](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections/retrieve.md): Get an API collection by ID or fully qualified name - [Update an API Collection](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections/update.md): Create or update an API collection with a full request body - [API Collection Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-collections/versions.md): List and retrieve historical versions of an API collection #### Api Endpoints - [API Endpoints](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints.md): Create and manage API endpoints within an API collection - [Create an API Endpoint](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints/create.md): Create a new API endpoint within an API collection - [Delete an API Endpoint](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints/delete.md): Delete an API endpoint by ID or name, with soft/hard delete options - [List API Endpoints](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints/list.md): List all API endpoints with optional filtering and pagination - [Retrieve an API Endpoint](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints/retrieve.md): Get an API endpoint by ID or fully qualified name - [Update an API Endpoint](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints/update.md): Create or update an API endpoint with a full request body - [API Endpoint Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/api-endpoints/versions.md): List and retrieve historical versions of an API endpoint #### Charts - [Charts](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts.md): Create and manage charts within a dashboard service - [Create a Chart](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts/create.md): Create a new chart within a dashboard service - [Delete a Chart](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts/delete.md): Delete a chart by ID or name, with soft/hard delete options - [List Charts](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts/list.md): List all charts with optional filtering and pagination - [Retrieve a Chart](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts/retrieve.md): Get a chart by ID or fully qualified name - [Update a Chart](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts/update.md): Create or update a chart with a full request body - [Chart Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/charts/versions.md): List and retrieve historical versions of a chart #### Containers - [Containers](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers.md): Create and manage containers within a storage service - [Create a Container](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers/create.md): Create a new container within a storage service - [Delete a Container](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers/delete.md): Delete a container by ID or name, with soft/hard delete options - [List Containers](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers/list.md): List all containers with optional filtering and pagination - [Retrieve a Container](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers/retrieve.md): Get a container by ID or fully qualified name - [Update a Container](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers/update.md): Create or update a container with a full request body - [Container Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/containers/versions.md): List and retrieve historical versions of a container #### Dashboard Services - [Dashboard Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services.md): Create and manage dashboard service connections - [Create a Dashboard Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/create.md): Create a new dashboard service connection - [Delete a Dashboard Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/delete.md): Delete a dashboard service by ID or name, with soft/hard delete options - [Import & Export Dashboard Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/import-export.md): Import and export dashboard service metadata as CSV - [List Dashboard Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/list.md): List all dashboard services with optional filtering and pagination - [Retrieve a Dashboard Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/retrieve.md): Get a dashboard service by ID or fully qualified name - [Update a Dashboard Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/update.md): Create or update a dashboard service with a full request body - [Dashboard Service Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboard-services/versions.md): List and retrieve historical versions of a dashboard service #### Dashboards - [Dashboards](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards.md): Create and manage dashboards within a dashboard service - [Create a Dashboard](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/create.md): Create a new dashboard within a dashboard service - [Delete a Dashboard](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/delete.md): Delete a dashboard by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/followers-votes.md): Manage followers and votes for dashboards - [List Dashboards](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/list.md): List all dashboards with optional filtering and pagination - [Retrieve a Dashboard](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/retrieve.md): Get a dashboard by ID or fully qualified name - [Update a Dashboard](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/update.md): Create or update a dashboard with a full request body - [Dashboard Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/dashboards/versions.md): List and retrieve historical versions of a dashboard #### Database Schemas - [Database Schemas](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas.md): Create and manage database schemas within a database - [Advanced Database Schema Operations](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/advanced.md): Manage followers, votes, and profiler configuration for database schemas - [Create a Database Schema](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/create.md): Create a new database schema within a database - [Delete a Database Schema](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/delete.md): Delete a database schema by ID or name, with soft/hard delete options - [Import & Export Database Schemas](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/import-export.md): Import and export database schema metadata as CSV - [List Database Schemas](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/list.md): List all database schemas with optional filtering and pagination - [Retrieve a Database Schema](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/retrieve.md): Get a database schema by ID or fully qualified name - [Update a Database Schema](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/update.md): Create or update a database schema with a full request body - [Database Schema Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-schemas/versions.md): List and retrieve historical versions of a database schema #### Database Services - [Database Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services.md): Create and manage database service connections - [Create a Database Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/create.md): Create a new database service connection - [Delete a Database Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/delete.md): Delete a database service by ID or name, with soft/hard delete options - [Import & Export Database Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/import-export.md): Import and export database service metadata as CSV - [List Database Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/list.md): List all database services with optional filtering and pagination - [Retrieve a Database Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/retrieve.md): Get a database service by ID or fully qualified name - [Update a Database Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/update.md): Create or update a database service with a full request body - [Database Service Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/database-services/versions.md): List and retrieve historical versions of a database service #### Databases - [Databases](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases.md): Create and manage database containers within a service - [Advanced Database Operations](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/advanced.md): Manage followers, votes, and profiler configuration for databases - [Create a Database](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/create.md): Create a new database within a database service - [Delete a Database](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/delete.md): Delete a database by ID or name, with soft/hard delete options - [Import & Export Databases](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/import-export.md): Import and export database metadata as CSV - [List Databases](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/list.md): List all databases with optional filtering and pagination - [Retrieve a Database](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/retrieve.md): Get a database by ID or fully qualified name - [Update a Database](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/update.md): Create or update a database with a full request body - [Database Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/databases/versions.md): List and retrieve historical versions of a database #### Messaging Services - [Messaging Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services.md): Create and manage messaging service connections - [Create a Messaging Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/create.md): Create a new messaging service connection - [Delete a Messaging Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/delete.md): Delete a messaging service by ID or name, with soft/hard delete options - [Import & Export Messaging Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/import-export.md): Import and export messaging service metadata as CSV - [List Messaging Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/list.md): List all messaging services with optional filtering and pagination - [Retrieve a Messaging Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/retrieve.md): Get a messaging service by ID or fully qualified name - [Update a Messaging Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/update.md): Create or update a messaging service with a full request body - [Messaging Service Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/messaging-services/versions.md): List and retrieve historical versions of a messaging service #### Mlmodel Services - [ML Model Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services.md): Create and manage ML model service connections - [Create an ML Model Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services/create.md): Create a new ML model service connection - [Delete an ML Model Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services/delete.md): Delete an ML model service by ID or name, with soft/hard delete options - [List ML Model Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services/list.md): List all ML model services with optional filtering and pagination - [Retrieve an ML Model Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services/retrieve.md): Get an ML model service by ID or fully qualified name - [Update an ML Model Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services/update.md): Create or update an ML model service with a full request body - [ML Model Service Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodel-services/versions.md): List and retrieve historical versions of an ML model service #### Mlmodels - [ML Models](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels.md): Create and manage ML models within an ML model service - [Create an ML Model](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/create.md): Create a new ML model within an ML model service - [Delete an ML Model](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/delete.md): Delete an ML model by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/followers-votes.md): Manage followers and votes for ML models - [List ML Models](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/list.md): List all ML models with optional filtering and pagination - [Retrieve an ML Model](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/retrieve.md): Get an ML model by ID or fully qualified name - [Update an ML Model](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/update.md): Create or update an ML model with a full request body - [ML Model Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/mlmodels/versions.md): List and retrieve historical versions of an ML model #### Pipeline Services - [Pipeline Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services.md): Create and manage pipeline service connections - [Create a Pipeline Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/create.md): Create a new pipeline service connection - [Delete a Pipeline Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/delete.md): Delete a pipeline service by ID or name, with soft/hard delete options - [Import & Export Pipeline Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/import-export.md): Import and export pipeline service metadata as CSV - [List Pipeline Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/list.md): List all pipeline services with optional filtering and pagination - [Retrieve a Pipeline Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/retrieve.md): Get a pipeline service by ID or fully qualified name - [Update a Pipeline Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/update.md): Create or update a pipeline service with a full request body - [Pipeline Service Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipeline-services/versions.md): List and retrieve historical versions of a pipeline service #### Pipelines - [Pipelines](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines.md): Create and manage pipelines within a pipeline service - [Create a Pipeline](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/create.md): Create a new pipeline within a pipeline service - [Delete a Pipeline](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/delete.md): Delete a pipeline by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/followers-votes.md): Manage followers and votes for pipelines - [List Pipelines](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/list.md): List all pipelines with optional filtering and pagination - [Retrieve a Pipeline](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/retrieve.md): Get a pipeline by ID or fully qualified name - [Update a Pipeline](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/update.md): Create or update a pipeline with a full request body - [Pipeline Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/pipelines/versions.md): List and retrieve historical versions of a pipeline #### Search Indexes - [Search Indexes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes.md): Create and manage search indexes within a search service - [Create a Search Index](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/create.md): Create a new search index within a search service - [Delete a Search Index](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/delete.md): Delete a search index by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/followers-votes.md): Manage followers and votes for search indexes - [List Search Indexes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/list.md): List all search indexes with optional filtering and pagination - [Retrieve a Search Index](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/retrieve.md): Get a search index by ID or fully qualified name - [Update a Search Index](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/update.md): Create or update a search index with a full request body - [Search Index Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/search-indexes/versions.md): List and retrieve historical versions of a search index #### Storage Services - [Storage Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services.md): Create and manage storage service connections - [Create a Storage Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services/create.md): Create a new storage service connection - [Delete a Storage Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services/delete.md): Delete a storage service by ID or name, with soft/hard delete options - [List Storage Services](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services/list.md): List all storage services with optional filtering and pagination - [Retrieve a Storage Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services/retrieve.md): Get a storage service by ID or fully qualified name - [Update a Storage Service](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services/update.md): Create or update a storage service with a full request body - [Storage Service Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/storage-services/versions.md): List and retrieve historical versions of a storage service #### Stored Procedures - [Stored Procedures](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures.md): Create and manage stored procedures within a database schema - [Create a Stored Procedure](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/create.md): Create a new stored procedure within a database schema - [Delete a Stored Procedure](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/delete.md): Delete a stored procedure by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/followers-votes.md): Manage followers and votes for stored procedures - [List Stored Procedures](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/list.md): List all stored procedures with optional filtering and pagination - [Retrieve a Stored Procedure](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/retrieve.md): Get a stored procedure by ID or fully qualified name - [Update a Stored Procedure](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/update.md): Create or update a stored procedure with a full request body - [Stored Procedure Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/stored-procedures/versions.md): List and retrieve historical versions of a stored procedure #### Tables - [Tables](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables.md): Create and manage table entities within a database schema - [Create a Table](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/create.md): Create a new table within a database schema - [Custom Metrics](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/custom-metrics.md): Add and delete custom metrics for tables - [Delete a Table](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/delete.md): Delete a table by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/followers-votes.md): Manage followers and votes for tables - [Import & Export Tables](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/import-export.md): Import and export table metadata as CSV - [List Tables](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/list.md): List all tables with optional filtering and pagination - [Pipeline Observability](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/observability.md): Get and set pipeline observability data for tables - [Table Profiler](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/profiler.md): Manage profiler configuration and retrieve profile data for tables - [Table Relationships](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/relationships.md): Manage joins, data models, columns, and entity relationships for tables - [Retrieve a Table](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/retrieve.md): Get a table by ID or fully qualified name - [Table Sample Data](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/sample-data.md): Get, add, and delete sample data for a table - [Update a Table](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/update.md): Create or update a table with a full request body - [Table Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/tables/versions.md): List and retrieve historical versions of a table #### Topics - [Topics](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics.md): Create and manage topics within a messaging service - [Create a Topic](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/create.md): Create a new topic within a messaging service - [Delete a Topic](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/delete.md): Delete a topic by ID or name, with soft/hard delete options - [Followers & Votes](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/followers-votes.md): Manage followers and votes for topics - [List Topics](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/list.md): List all topics with optional filtering and pagination - [Retrieve a Topic](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/retrieve.md): Get a topic by ID or fully qualified name - [Update a Topic](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/update.md): Create or update a topic with a full request body - [Topic Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-assets/topics/versions.md): List and retrieve historical versions of a topic ### AI SDK - [AI SDK](https://docs.open-metadata.org/v1.13.x/sdk/ai-sdk.md): Bring AI to your metadata. Programmatic access to OpenMetadata through MCP tools and AI Studio Agents across Python, TypeScript, Java, and CLI. ### SDK - [OpenMetadata SDK | OpenMetadata Software Development Kit](https://docs.open-metadata.org/v1.13.x/api-reference/sdk.md): Connect Sdk to enable streamlined access, monitoring, or search of enterprise data using secure and scalable integrations. - [OpenMetadata Standards](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/openmetadata-standards.md): Explore the open standard for unified metadata management, including JSON Schemas, RDF/OWL ontologies, and API specifications. #### Go SDK - [Go SDK](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/go.md) - [Go SDK - API Methods](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/go-api-methods.md) #### Python - [Python SDK | OpenMetadata Python SDK Documentation](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python.md): Master OpenMetadata'sPython SDK with comprehensive documentation, code examples, and API guides. Build powerful data discovery and governance solutions. - [Python SDK Overview](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/overview.md): Full-featured Python client library for OpenMetadata integration ##### API Reference - [Overview](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference.md) - [Aut Provider](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/auth-provider.md) - [Client Utils](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/client-utils.md) - [Client](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/client.md) - [Credentials](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/credentials.md) - [Dashboard Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/dashboard-mixin.md) - [Data Insight Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/data-insight-mixin.md) - [ES Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/es-mixin.md) - [Ingestion Pipeline Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/ingestion-pipeline-mixin.md) - [Lineage Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/lineage-mixin.md) - [ML Model Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/mlmodel-mixin.md) - [Models](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/models.md) - [Ometa API](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/ometa-api.md) - [Patch Mixin Utils](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/patch-mixin-utils.md) - [Patch Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/patch-mixin.md) - [Pipeline Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/pipeline-mixin.md) - [Provider Registry](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/provider-registry.md) - [Query Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/query-mixin.md) - [Role Policy Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/role-policy-mixin.md) - [Routes](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/routes.md) - [Search Index Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/search-index-mixin.md) - [Server Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/server-mixin.md) - [Service Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/service-mixin.md) - [Table Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/table-mixin.md) - [Test Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/tests-mixin.md) - [Topic Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/topic-mixin.md) - [User Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/user-mixin.md) - [Utils](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/utils.md) - [version Mixin](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/api-reference/version-mixin.md) ##### Build Connector - [Build a Connector](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/build-connector.md) - [Bulk Sink](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/build-connector/bulk-sink.md): Learn to build powerful bulk sink connectors with OpenMetadata'sPython SDK. Step-by-step guide with code examples for efficient data ingestion. - [Sink](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/build-connector/sink.md): Learn to build custom sink connectors for OpenMetadata using Python SDK. Step-by-step guide with code examples to integrate and stream metadata efficiently. - [Source](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/build-connector/source.md) - [Stage](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/build-connector/stage.md): Learn to build custom OpenMetadata Python connectors with our comprehensive stage development guide. Step-by-step tutorials and code examples included. ##### Entities - [ML Model | OpenMetadata Machine Learning Model SDK](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/entities/ml-model.md): Learn to manage ML models with OpenMetadata Python SDK. Complete guide with code examples, entity operations, and API integration for machine learning workflows. ##### Ingestion - [Python SDK Ingestion](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/ingestion.md) - [Python SDK for Lineage](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/ingestion/lineage.md): Learn to implement data lineage tracking with OpenMetadata'sPython SDK. Complete guide with code examples, API usage, and best practices for data flow ... - [Python SDK for Tags](https://docs.open-metadata.org/v1.13.x/api-reference/sdk/python/ingestion/tags.md) ### Discovery - [Discovery](https://docs.open-metadata.org/v1.13.x/api-reference/discovery.md): Search and discover data assets across your metadata catalog - [Field Query](https://docs.open-metadata.org/v1.13.x/api-reference/discovery/field-query.md): Search for entities by specific field values - [Search Entities](https://docs.open-metadata.org/v1.13.x/api-reference/discovery/search.md): Full-text search across all entity types in the metadata catalog ### Lineage - [Lineage](https://docs.open-metadata.org/v1.13.x/api-reference/lineage/index.md): Query, create, delete, and export data lineage between entities - [Get Lineage](https://docs.open-metadata.org/v1.13.x/api-reference/lineage/get.md): Retrieve the lineage graph for an entity by ID or fully qualified name - [Add Lineage](https://docs.open-metadata.org/v1.13.x/api-reference/lineage/add.md): Create a lineage edge between two entities - [Delete Lineage](https://docs.open-metadata.org/v1.13.x/api-reference/lineage/delete.md): Remove a lineage edge between two entities - [Export Lineage](https://docs.open-metadata.org/v1.13.x/api-reference/lineage/export.md): Export the lineage graph for an entity as CSV ### Data Contracts - [Data Contracts](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts.md): Define schema, quality, and governance guarantees for data assets - [Create a Data Contract](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/create.md): Create a new data contract for a data asset - [Delete a Data Contract](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/delete.md): Delete or restore a data contract - [List Data Contracts](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/list.md): List and filter data contracts - [Import & Export](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/odcs.md): Import and export data contracts using the Open Data Contract Standard (ODCS) v3.1.0 format - [Retrieve a Data Contract](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/retrieve.md): Get a data contract by ID, fully qualified name, or entity reference - [Update a Data Contract](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/update.md): Create or update a data contract with a full request body - [Validate & Results](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/validate.md): Validate data contracts and manage execution results - [Data Contract Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-contracts/versions.md): Track version history of data contract changes ### Teams And Users - [Teams & Users](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users.md): APIs for managing users and teams #### Teams - [Teams](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams.md): Create and manage teams for organizing users and controlling access - [Create a Team](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams/create.md): Create a new team for organizing users and controlling access - [Delete a Team](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams/delete.md): Delete a team by ID, with soft/hard delete options - [List Teams](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams/list.md): List all teams with optional filtering and pagination - [Retrieve a Team](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams/retrieve.md): Get a team by ID or fully qualified name - [Update a Team](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams/update.md): Create or update a team with a full request body - [Team Versions](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/teams/versions.md): List and retrieve historical versions of a team #### Users - [Users](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users.md): Create and manage users in your organization - [Create a User](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users/create.md): Create a new user in your organization - [Delete a User](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users/delete.md): Delete a user by ID or name, with soft/hard delete options - [List Users](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users/list.md): List all users with optional filtering and pagination - [Retrieve a User](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users/retrieve.md): Get a user by ID or fully qualified name - [Update a User](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users/update.md): Create or update a user with a full request body - [User Versions](https://docs.open-metadata.org/v1.13.x/api-reference/teams-and-users/users/versions.md): List and retrieve historical versions of a user ### Data Governance - [Governance](https://docs.open-metadata.org/v1.13.x/api-reference/governance.md): APIs for data governance — domains, data products, glossaries, classifications, and tags #### Classifications - [Classifications](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications.md): Create and manage classifications for organizing tags - [Create a Classification](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications/create.md): Create a new classification for organizing tags - [Delete a Classification](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications/delete.md): Delete a classification by ID or name, with soft/hard delete options - [List Classifications](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications/list.md): List all classifications with optional filtering and pagination - [Retrieve a Classification](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications/retrieve.md): Get a classification by ID or fully qualified name - [Update a Classification](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications/update.md): Create or update a classification with a full request body - [Classification Versions](https://docs.open-metadata.org/v1.13.x/api-reference/governance/classifications/versions.md): List and retrieve historical versions of a classification #### Data Products - [Data Products](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products.md): Create and manage data products within domains - [Create a Data Product](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/create.md): Create a new data product within a domain - [Delete a Data Product](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/delete.md): Delete a data product by ID or name, permanently - [List Data Products](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/list.md): List all data products with optional filtering and pagination - [Ports & Assets](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/ports-assets.md): Manage input ports, output ports, and assets for a data product - [Retrieve a Data Product](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/retrieve.md): Get a data product by ID or fully qualified name - [Update a Data Product](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/update.md): Create or update a data product with a full request body - [Data Product Versions](https://docs.open-metadata.org/v1.13.x/api-reference/governance/data-products/versions.md): List and retrieve historical versions of a data product #### Domains - [Domains](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains.md): Create and manage domains for organizing data assets by business areas - [Create a Domain](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains/create.md): Create a new domain for organizing data assets by business area - [Delete a Domain](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains/delete.md): Delete a domain by ID or name, permanently - [List Domains](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains/list.md): List all domains with optional filtering and pagination - [Retrieve a Domain](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains/retrieve.md): Get a domain by ID or fully qualified name - [Update a Domain](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains/update.md): Create or update a domain with a full request body - [Domain Versions](https://docs.open-metadata.org/v1.13.x/api-reference/governance/domains/versions.md): List and retrieve historical versions of a domain #### Glossaries - [Glossaries](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries.md): Create and manage glossaries for business terminology - [Create a Glossary](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries/create.md): Create a new glossary for business terminology - [Delete a Glossary](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries/delete.md): Delete a glossary by ID or name, with soft/hard delete options - [List Glossaries](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries/list.md): List all glossaries with optional filtering and pagination - [Retrieve a Glossary](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries/retrieve.md): Get a glossary by ID or fully qualified name - [Update a Glossary](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries/update.md): Create or update a glossary with a full request body - [Glossary Versions](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossaries/versions.md): List and retrieve historical versions of a glossary #### Glossary Terms - [Glossary Terms](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms.md): Create and manage glossary terms within glossaries - [Create a Glossary Term](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms/create.md): Create a new glossary term within a glossary - [Delete a Glossary Term](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms/delete.md): Delete a glossary term by ID or name, with soft/hard delete options - [List Glossary Terms](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms/list.md): List all glossary terms with optional filtering and pagination - [Retrieve a Glossary Term](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms/retrieve.md): Get a glossary term by ID or fully qualified name - [Update a Glossary Term](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms/update.md): Create or update a glossary term with a full request body - [Glossary Term Versions](https://docs.open-metadata.org/v1.13.x/api-reference/governance/glossary-terms/versions.md): List and retrieve historical versions of a glossary term #### Tags - [Tags](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags.md): Create and manage tags within classifications - [Create a Tag](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags/create.md): Create a new tag within a classification - [Delete a Tag](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags/delete.md): Delete a tag by ID or name, with soft/hard delete options - [List Tags](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags/list.md): List all tags with optional filtering and pagination - [Retrieve a Tag](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags/retrieve.md): Get a tag by ID or fully qualified name - [Update a Tag](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags/update.md): Create or update a tag with a full request body - [Tag Versions](https://docs.open-metadata.org/v1.13.x/api-reference/governance/tags/versions.md): List and retrieve historical versions of a tag ### Data Quality - [Data Quality](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality.md): APIs for managing data quality test definitions, test suites, and test cases #### Test Cases - [Test Cases](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases.md): Create and manage data quality test case instances applied to specific tables and columns - [Create a Test Case](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/create.md): Create a new test case instance applied to a specific table or column - [Delete a Test Case](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/delete.md): Delete a test case by ID or name, with soft/hard delete options - [List Test Cases](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/list.md): List all test cases with optional filtering and pagination - [Test Case Results](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/results.md): Get and add test case execution results - [Retrieve a Test Case](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/retrieve.md): Get a test case by ID or fully qualified name - [Update a Test Case](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/update.md): Create or update a test case with a full request body - [Test Case Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-cases/versions.md): List and retrieve historical versions of a test case #### Test Definitions - [Test Definitions](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-definitions.md): Define reusable data quality validation rules for tables and columns - [Create a Test Definition](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-definitions/create.md): Create a custom test definition for data quality validation - [List Test Definitions](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-definitions/list.md): List all test definitions with optional filtering and pagination - [Retrieve a Test Definition](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-definitions/retrieve.md): Get a test definition by ID or name #### Test Suites - [Test Suites](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites.md): Organize test cases into basic or logical groupings - [Create a Test Suite](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites/create.md): Create a logical test suite or a basic test suite for a table - [Delete a Test Suite](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites/delete.md): Delete a test suite by ID or name, with soft/hard delete options - [List Test Suites](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites/list.md): List all test suites with optional filtering and pagination - [Retrieve a Test Suite](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites/retrieve.md): Get a test suite by ID or fully qualified name - [Update a Test Suite](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites/update.md): Create or update a test suite with a full request body - [Test Suite Versions](https://docs.open-metadata.org/v1.13.x/api-reference/data-quality/test-suites/versions.md): List and retrieve historical versions of a test suite ### Main Concepts - [Main Concepts | OpenMetadata Core Concepts Overview](https://docs.open-metadata.org/v1.13.x/api-reference/main-concepts.md): Connect Main Concepts to enable streamlined access, monitoring, or search of enterprise data using secure and scalable integrations. - [High Level Design | OpenMetadata Architecture Overview](https://docs.open-metadata.org/v1.13.x/api-reference/main-concepts/high-level-design.md): Explore high-level architectural design to understand how components interact across storage, processing, and access layers. - [Backend DB](https://docs.open-metadata.org/v1.13.x/api-reference/main-concepts/backend-db.md) #### Metadata Standard - [Metadata Standard | OpenMetadata Core Schema Guide](https://docs.open-metadata.org/v1.13.x/api-reference/main-concepts/metadata-standard.md): Overview of metadata standard schemas governing how entities, types, analytics, and governance structures are defined. - [APIs | OpenMetadata Metadata Standard APIs](https://docs.open-metadata.org/v1.13.x/api-reference/main-concepts/metadata-standard/apis.md)