Generate semantic model

curl --request POST \ --url https://api.example.com/api/semantic-models/generate \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "domain_name": "<string>", "domain_urn": "<string>", "user_prompt": "<string>", "include_tables": [ "<string>" ], "exclude_tables": [ "<string>" ], "target_catalog": "iceberg", "target_schema": "<string>", "auto_submit_for_review": true } '

{ "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "celery_task_id": "<string>", "domain_urn": "<string>", "status": "<string>", "submitted_by": "<string>", "submitted_at": "2023-11-07T05:31:56Z", "message": "Task submitted successfully.", "models_generated": 123, "result_model_ids": [ "<string>" ] }

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 generate semantic models using AI.

domain_name

string | null

Domain name. For example, Finance. Either domain_name or domain_urn is required.

domain_urn

string | null

DataHub domain URN. For example, urn:li:domain:Finance. Either domain_name or domain_urn is required.

user_prompt

string | null

Optional description of what kind of models to generate.

include_tables

string[] | null

Specific tables to include. Default: All tables in a domain

exclude_tables

string[] | null

Tables to exclude from generation.

target_catalog

string

default:iceberg

Target Trino catalog for views.

target_schema

string | null

Target schema. Default: domain name

auto_submit_for_review

boolean

default:true

Automatically submit generated models for review.

Response

Generation task submitted

Response for a generation task submission.

task_id

string<uuid>

required

Internal task ID.

celery_task_id

string

required

Celery task ID. Empty if synchronous.

domain_urn

string

required

status

string

required

submitted_by

string

required

submitted_at

string<date-time>

required

message

string

default:Task submitted successfully.

models_generated

integer | null

Number of models generated if completed.

result_model_ids

string[] | null

IDs of generated models if completed.