Skip to main content

Collate API Reference

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

Base URL

All API requests should be made to your Collate instance. For self-hosted deployments, use your configured host.
https://{your-company}.getcollate.io/api/v1
https://your-host.com/api/v1

Quick Start

Get started with a simple API call to list tables in your catalog:
Python
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
    OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
    OpenMetadataJWTClientConfig,
)

# Configure connection
server_config = OpenMetadataConnection(
    hostPort="https://your-company.getcollate.io/api",
    authProvider="openmetadata",
    securityConfig=OpenMetadataJWTClientConfig(
        jwtToken="your-jwt-token"
    ),
)

# Create client
metadata = OpenMetadata(server_config)

# List tables
tables = metadata.list_all_entities(entity=Table)
for table in tables:
    print(f"{table.fullyQualifiedName}: {table.description}")

Authentication

All API requests require authentication using a JWT Bearer token. You can obtain a token by:
  1. Bot Token: Go to Settings > Bots in the Collate UI to create a service account
  2. Personal Access Token: Go to your Profile > Access Tokens to generate a personal token
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

SDKs

We provide official SDKs for Python and Java:

Error Handling

The API uses conventional HTTP response codes:
CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing token
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
409Conflict - Resource already exists
500Internal Server Error

Rate Limits

API requests are subject to rate limiting to ensure fair usage. If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

Need Help?