Skip to content

list_data_sources

Use list_data_sources before query_data so table and column names are grounded in the live model catalog.

read-only · idempotent

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model whose data sources to list.')]Yes
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • model_name (string)
  • sources (array<object>)
  • total_count (integer)

See the response example below for the full payload shape.

{
"name": "list_data_sources",
"arguments": {
"model_name": "forecasts"
}
}
{
"model_name": "forecasts",
"sources": [
{
"source_name": "actuals",
"source_type": "parquet",
"tables": [
"actuals"
],
"snapshot_taken_at": null,
"snapshot_age_seconds": null,
"schema": {
"actuals": [
{
"name": "month",
"dtype": "timestamp[us]"
},
{
"name": "revenue",
"dtype": "float64"
}
]
},
"data_source_id": null,
"spreadsheet_id": null,
"queryable": true,
"runnable": true
},
{
"source_name": "headcount_sheet",
"source_type": "google_sheets",
"tables": [
"headcount_sheet__roles",
"headcount_sheet__hires"
],
"snapshot_taken_at": "2026-04-28T10:00:00+00:00",
"snapshot_age_seconds": 10800,
"schema": {
"headcount_sheet__roles": [
{
"name": "role",
"dtype": "string"
}
]
},
"data_source_id": "88888888-8888-8888-8888-888888888888",
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"queryable": true,
"runnable": true
},
{
"source_name": "vendor_invoices",
"source_type": "file_upload",
"tables": [],
"snapshot_taken_at": null,
"snapshot_age_seconds": null,
"schema": {},
"data_source_id": "e1e10000-e1e1-e1e1-e1e1-e1e100000001",
"spreadsheet_id": null,
"original_filename": "vendor_invoices_2026q1.csv",
"file_kind": "csv_file",
"columns": [
{
"name": "vendor",
"inferred_type": "text"
},
{
"name": "amount",
"inferred_type": "number"
}
],
"row_count": 412,
"readiness": "ready",
"queryable": false,
"runnable": true,
"canonical_mount_root": "/data/_sources/e1e10000-e1e1-e1e1-e1e1-e1e100000001/",
"canonical_mount_path": "/data/_sources/e1e10000-e1e1-e1e1-e1e1-e1e100000001/data.csv",
"legacy_mount_path": "/data/data.csv",
"redacted_snapshot_identity": "snap_3f9a2c7e10b845d1",
"metadata_unavailable": false
}
],
"total_count": 3
}
  • Module: Data
  • Requires authentication via API token or Auth0 JWT.