Skip to main content
POST
/
api
/
semantic-models
Create semantic model
curl --request POST \
  --url https://api.example.com/api/semantic-models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domain_urn": "<string>",
  "domain_name": "<string>",
  "source_tables": [
    "<string>"
  ],
  "generated_sql": "<string>",
  "target_catalog": "<string>",
  "target_schema": "<string>",
  "description": "",
  "columns": [],
  "ai_confidence_score": 123,
  "ai_reasoning": "<string>"
}
'
{
  "name": "<string>",
  "domain_urn": "<string>",
  "domain_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_tables": "<string>",
  "generated_sql": "<string>",
  "approved_sql": "<string>",
  "target_catalog": "<string>",
  "target_schema": "<string>",
  "view_name": "<string>",
  "ai_confidence_score": 123,
  "ai_reasoning": "<string>",
  "generation_task_id": "<string>",
  "reviewed_by": "<string>",
  "reviewed_at": "2023-11-07T05:31:56Z",
  "review_notes": "<string>",
  "schedule_cron": "<string>",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "<string>",
  "owner_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deployed_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "version": 123,
  "parent_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": ""
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request to create a semantic model.

​
name
string
required

Business-friendly model name.

​
domain_urn
string
required

DataHub domain URN.

​
domain_name
string
required

Human-readable domain name.

​
source_tables
string[]
required

List of source table URNs.

​
generated_sql
string
required

SQL query for the view.

​
target_catalog
string
required

Trino catalog.

​
target_schema
string
required

Trino schema.

​
description
string
default:""

Model description.

​
columns
SemanticModelColumnCreate · object[]

Column definitions.

​
ai_confidence_score
number | null

AI confidence score.

​
ai_reasoning
string | null

AI reasoning for this model.

Response

Model created successfully

Response model for a semantic model.

​
name
string
required

Business-friendly model name.

​
domain_urn
string
required

DataHub domain URN.

​
domain_name
string
required

Human-readable domain name.

​
id
string<uuid>
required
​
source_tables
string
required
​
generated_sql
string
required
​
approved_sql
string | null
required
​
target_catalog
string
required
​
target_schema
string
required
​
view_name
string | null
required
​
status
enum<string>
required

Status of a semantic model.

Available options:
draft,
pending_review,
approved,
rejected,
deployed,
failed,
archived
​
ai_confidence_score
number | null
required
​
ai_reasoning
string | null
required
​
generation_task_id
string | null
required
​
reviewed_by
string | null
required
​
reviewed_at
string<date-time> | null
required
​
review_notes
string | null
required
​
schedule_cron
string | null
required
​
job_id
string<uuid> | null
required
​
created_by
string
required
​
owner_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
deployed_at
string<date-time> | null
required
​
external_id
string | null
required
​
version
integer
required
​
parent_model_id
string<uuid> | null
required
​
description
string
default:""

Model description.