Skip to content

share_model

Share a Bridge Town model with another tenant by copying it into their project with provenance tracking. The copy includes a provenance header identifying the source tenant, project, and model. The share relationship is recorded for auditing. Requires at least Viewer access to the source project. Returns: source_project (str); source_model (str); target_tenant (str); target_project (str); target_model (str); target_path (str) — path in the target project; commit_sha (str) — commit SHA in the target project; shared_at (str) — ISO 8601 timestamp. Requires Pro plan.

NameTypeRequiredDefaultDescription
source_project_namestrYes
model_namestrYes
target_tenant_slugstrYes
target_project_namestrYes
target_model_namestrNo''

Returns a structured object. Top-level fields:

  • source_project (string)
  • source_model (string)
  • target_tenant (string)
  • target_project (string)
  • target_model (string)
  • target_path (string)
  • commit_sha (string)
  • shared_at (string)

See the response example below for the full payload shape.

{
"name": "share_model",
"arguments": {
"source_project_name": "platform",
"model_name": "shared_growth",
"target_tenant_slug": "partner-co",
"target_project_name": "forecasts",
"target_model_name": "growth"
}
}
{
"source_project": "platform",
"source_model": "shared_growth",
"target_tenant": "partner-co",
"target_project": "forecasts",
"target_model": "growth",
"target_path": "model/revenue.py",
"commit_sha": "abc1234def5678901234567890abcdef12345678",
"shared_at": "2026-04-28T10:00:00+00:00"
}
  • Module: Sharing
  • Requires authentication via API token or Auth0 JWT.