Data sources API

name

string

Yes

Unique within your organization.

source_type

string

Yes

Warehouse type: postgres, snowflake, bigquery, databricks, athena, redshift or trino.

category

string

Ignored; derived from source_type.

initial_workspace_id

UUID

Workspace the source is first shared with; it holds the staged data. Needs admin rights on it.

workspace_ids

list of UUID

More workspaces to share the source with. Needs admin rights on each.

config

object

Connection settings; the keys depend on source_type, such as project_id for BigQuery or host and database for Postgres. auth_method picks the credentials shape.

credentials

object

Secret login details; which keys are required depends on source_type and config.auth_method, such as service_account_json for BigQuery.

include_patterns

list of string

Only sync schemas (BigQuery datasets) whose name matches one of these case-sensitive glob patterns, such as marketing_*. Empty means all.

exclude_patterns

list of string

Skip schemas whose name matches one of these glob patterns. Wins over include_patterns.

service_config_id

UUID

An OAuth client configuration; required for Databricks oauth_m2m and azure_sp.

schedule

string

Cron expression, in UTC, for automatic metadata syncs. Empty removes the schedule.

mode

string

dev: syncs run but the assistant cannot query the source. active: both allowed. disabled: everything paused.

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

workspace_id

query

UUID

Yes

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

q

query

string

Yes

scope

query

string

limit

query

integer

id

UUID

name

string

result_type

string

path

string

datasource_id

UUID

asset_id

UUID

datasource_name

string

collection_name

string

asset_name

string

field_name

string

comment

string

data_type

string

datasource_id

path

UUID

Yes

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

datasource_id

path

UUID

Yes

name

string

config

object

Connection settings; the keys depend on source_type, such as project_id for BigQuery or host and database for Postgres. auth_method picks the credentials shape.

credentials

object

Secret login details; which keys are required depends on source_type and config.auth_method, such as service_account_json for BigQuery. Changing them resets the verification status.

include_patterns

list of string

Only sync schemas (BigQuery datasets) whose name matches one of these case-sensitive glob patterns, such as marketing_*. Empty means all.

exclude_patterns

list of string

Skip schemas whose name matches one of these glob patterns. Wins over include_patterns.

service_config_id

UUID

An OAuth client configuration; required for Databricks oauth_m2m and azure_sp. Send null to remove the link.

schedule

string

Cron expression, in UTC, for automatic metadata syncs. Empty removes the schedule.

schedule_active

boolean

Pause (false) or resume (true) the existing sync schedule.

mode

string

dev: syncs run but the assistant cannot query the source. active: both allowed. disabled: everything paused.

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

datasource_id

path

UUID

Yes

datasource_id

path

UUID

Yes

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

datasource_id

path

UUID

Yes

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

datasource_id

path

UUID

Yes

datasource_id

path

UUID

Yes

id

UUID

name

string

comment

string

location

string

item_count

integer

created_at

datetime

updated_at

datetime

collection_id

path

UUID

Yes

exclude_views

query

boolean

id

UUID

name

string

comment

string

asset_type

string

row_count

integer

field_count

integer

created_at

datetime

updated_at

datetime

asset_id

path

UUID

Yes

id

UUID

name

string

data_type

string

is_nullable

boolean

is_primary_key

boolean

default_value

string

comment

string

ordinal_position

integer

null_rate

number

distinct_count

integer

has_pii

boolean

pii_types

list of string

asset_id

path

UUID

Yes

id

UUID

name

string

source_asset_id

UUID

source_asset_name

string

source_fields

list of string

target_asset_id

UUID

target_asset_name

string

target_fields

list of string

relationship_type

string

cardinality

string

is_confirmed

boolean

confidence

number

evidence

object

asset_id

path

UUID

Yes

id

UUID

name

string

source_type

string

category

string

config

object

has_credentials

boolean

include_patterns

list of string

exclude_patterns

list of string

is_verified

boolean

verified_at

datetime

last_error

string

health_status

string

last_health_check_at

datetime

mode

string

last_sync_execution_id

UUID

last_sync_status

string

last_sync_completed_at

datetime

service_config_id

UUID

schedule

string

schedule_active

boolean

last_scheduled_at

datetime

created_at

datetime

updated_at

datetime

datasource_id

path

UUID

Yes

datasource_id

UUID

Yes

asset_ids

list of UUID

Yes

asset_id

path

UUID

Yes

id

UUID

field_id

UUID

field_name

string

null_count

integer

total_count

integer

null_rate

number

distinct_count

integer

distinct_rate

number

min_value

string

max_value

string

mean_value

number

sample_values

list of string

created_at

datetime

median_value

number

stddev_value

number

percentiles

object

top_values

list of object

histogram

list of object

caveats

list of object

field_id

path

UUID

Yes

status

query

string

workspace_id

query

UUID

id

UUID

source_asset_id

UUID

source_asset_name

string

source_datasource_name

string

target_asset_id

UUID

target_asset_name

string

target_datasource_name

string

overlap_type

string

confidence

number

evidence

object

status

string

resolved_by_email

string

resolved_binding_id

UUID

hidden_asset_id

UUID

created_at

datetime

overlap_id

path

UUID

Yes

hide_asset_id

UUID

Yes

The duplicate table to hide in the workspace; one of the overlap’s two tables.

reason

string

Ignored; kept for compatibility.

id

UUID

source_asset_id

UUID

source_asset_name

string

source_datasource_name

string

target_asset_id

UUID

target_asset_name

string

target_datasource_name

string

overlap_type

string

confidence

number

evidence

object

status

string

resolved_by_email

string

resolved_binding_id

UUID

hidden_asset_id

UUID

created_at

datetime

overlap_id

path

UUID

Yes

id

UUID

source_asset_id

UUID

source_asset_name

string

source_datasource_name

string

target_asset_id

UUID

target_asset_name

string

target_datasource_name

string

overlap_type

string

confidence

number

evidence

object

status

string

resolved_by_email

string

resolved_binding_id

UUID

hidden_asset_id

UUID

created_at

datetime