Skip to main content
POST
/
api
/
semantic-models
/
match
Match Model To Catalog
curl --request POST \
  --url https://api.example.com/api/semantic-models/match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model_name": "<string>",
  "model_description": "",
  "desired_columns": [],
  "domain_name": "<string>",
  "domain_urn": "<string>",
  "include_tables": [
    "<string>"
  ],
  "exclude_tables": [
    "<string>"
  ],
  "target_catalog": "iceberg",
  "target_schema": "<string>"
}
'
{
  "model_name": "<string>",
  "model_description": "<string>",
  "source_tables": [],
  "columns": [],
  "generated_sql": "",
  "overall_confidence": 0,
  "ai_reasoning": "",
  "warnings": []
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-correlation-id
string | null

Body

application/json

Request to match a model definition against catalog metadata.

model_name
string
required

Name of the model being defined

model_description
string
default:""

What the model should represent

desired_columns
MatchModelColumn · object[]

Desired columns/metrics the model should expose

domain_name
string | null

Domain name. Either domain_name or domain_urn required.

domain_urn
string | null

Domain URN. Either domain_name or domain_urn required.

include_tables
string[] | null

Only consider these tables

exclude_tables
string[] | null

Exclude these tables from consideration

target_catalog
string
default:iceberg

Target Trino catalog

target_schema
string | null

Target Trino schema

Response

Matched model with source tables and columns

Response from catalog matching.

model_name
string
required
model_description
string
required
source_tables
MatchedSourceTable · object[]
columns
MatchedColumn · object[]
generated_sql
string
default:""

AI-generated SQL for the view

overall_confidence
number
default:0

Overall match confidence 0-1

ai_reasoning
string
default:""

AI explanation of the matching strategy

warnings
string[]

Any warnings about the match