Skip to main content
POST
Preview generation context

Authorizations

Authorization
string
header
required

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

Body

application/json

What a generation would be built from, before running it.

domain_name
string | null

Domain name.

domain_urn
string | null

Domain URN.

user_prompt
string | null

The generation brief.

include_tables
string[] | null
exclude_tables
string[] | null
documents
string[] | null

Document URNs to use; omit to let it pick.

Maximum array length: 20
business_rules
string[] | null

Business rules as workspace/key.

Maximum array length: 20

Response

Successful Response

The context a generation would use. Nothing here blocks generating.

domain_name
string
required
domain_urn
string
required
tables
string[]
documents
ContextDocument · object[]

The documents that will be used. Tell the user which.

business_rules
ContextBusinessRule · object[]
sensitive_columns
SensitiveColumn · object[]
columns_total
integer
default:0
columns_with_glossary_terms
integer
default:0
tables_with_failing_quality
string[]