Collate SDKs & APIs

The Collate API provides programmatic access to all metadata in your data catalog. Build integrations, automate workflows, and manage your data assets using the REST API or native SDKs.

Base URL

All API requests should be made to your Collate instance.

https://{your-company}.getcollate.io/api/v1

https://your-host.com/api/v1

Client Libraries

Install an official SDK to interact with the Collate API in your preferred language. Match the SDK version to your server release.

Python
Java
Go

pip install "openmetadata-ingestion~=YOUR_SERVER_VERSION"

The metadata.sdk examples require openmetadata-ingestion 1.10.0 or later. Install the package version that matches your server release.The Python SDK provides a high-level, type-safe API with built-in support for ingestion, lineage, and all entity operations.

<dependency>
  <groupId>org.open-metadata</groupId>
  <artifactId>openmetadata-sdk</artifactId>
  <version>YOUR_SERVER_VERSION</version>
</dependency>

The Java SDK integrates OpenMetadata into your JVM environment to provision and manage resources.

go get github.com/open-metadata/openmetadata-sdk/openmetadata-go-client@latest

The Go SDK provides typed services, automatic pagination, retry logic, and comprehensive error handling.

Quick Start

Get started with a simple API call to list tables in your catalog:

Python

from metadata.sdk import Tables, configure

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token",
)

# List tables
for table in Tables.list_all():
    print(f"{table.fullyQualifiedName}: {table.description}")

import org.openmetadata.sdk.client.OpenMetadata;
import org.openmetadata.sdk.models.ListParams;

// Configure connection
OpenMetadata.initialize(
    "https://your-company.getcollate.io/api",
    "your-jwt-token"
);

var client = OpenMetadata.client();

// List tables
var tables = client.tables().list(new ListParams().setLimit(10));
for (var table : tables.getData()) {
    System.out.println(table.getFullyQualifiedName());
}

import (
    "context"
    "fmt"
    "log"

    "github.com/open-metadata/openmetadata-sdk/openmetadata-go-client/pkg/ometa"
)

client := ometa.NewClient(
    "https://your-company.getcollate.io",
    ometa.WithToken("your-jwt-token"),
)

for table, err := range client.Tables.List(context.Background(), &ometa.ListTablesParams{
    Limit: ometa.Int32(10),
}) {
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(table.Name)
}

curl -X GET "https://your-company.getcollate.io/api/v1/tables?limit=10" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json"

Authentication

All API requests require authentication using a JWT Bearer token.

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

You can obtain a token through Bot Tokens (for service accounts via Settings > Bots — Admin-only) or Personal Access Tokens (via your Profile > Access Tokens).

Authentication Guide

Learn more about authentication methods, token management, and security configuration.

Error Handling

The API uses conventional HTTP response codes:

Code	Description
`200`	Success
`201`	Created
`400`	Bad Request — Invalid parameters
`401`	Unauthorized — Invalid or missing token
`403`	Forbidden — Insufficient permissions
`404`	Not Found — Resource doesn’t exist
`409`	Conflict — Resource already exists
`429`	Too Many Requests — Rate limit exceeded
`500`	Internal Server Error

Explore the API

Data Assets

Manage tables, dashboards, pipelines, topics, ML models, and more.

Discovery

Search and discover metadata across your catalog.

Data Contracts

Define and validate data contracts for your assets.

Teams & Users

Manage users, teams, and organizational structure.

Data Governance

Manage domains, glossaries, classifications, and tags.

Data Quality

Create and manage test suites, test cases, and quality metrics.

Need Help?

Support

Contact our support team

Community

Join the OpenMetadata Slack community

​Collate SDKs & APIs

​Base URL

​Client Libraries

​Quick Start

​Authentication