Skip to content

request_model_share

Request to share a Bridge Town model with another tenant. Creates a pending share request that the target tenant must explicitly accept. No model code is written to the target repo until acceptance. Requires at least Viewer access to the source project. Requires Pro plan. Returns: request_id, status=‘pending’, source_project, source_model, target_tenant, suggested_target_project, suggested_target_model, created_at.

NameTypeRequiredDefaultDescription
source_project_nameAnnotated[str, Field(description='Name of the source Bridge Town project.')]Yes
model_nameAnnotated[str, Field(description='Name of the model file to share (without .py extension).')]Yes
target_tenant_slugAnnotated[str, Field(description='Slug identifier of the target workspace to share the model with.')]Yes
suggested_target_projectAnnotated[str, Field(description='Suggested project name in the target workspace where the model should be placed.')]Yes
suggested_target_modelAnnotated[str, Field(description='Suggested name for the model in the target workspace.')]No''

Returns a structured object. Top-level fields:

  • request_id (string)
  • status (string)
  • source_project (string)
  • source_model (string)
  • target_tenant (string)
  • suggested_target_project (string)
  • suggested_target_model (string)
  • created_at (string)

See the response example below for the full payload shape.

{
"name": "request_model_share",
"arguments": {
"source_project_name": "platform",
"model_name": "revenue_forecast",
"target_tenant_slug": "partner-co",
"suggested_target_project": "forecasts",
"suggested_target_model": "acme_revenue_forecast"
}
}
{
"request_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"status": "pending",
"source_project": "platform",
"source_model": "revenue_forecast",
"target_tenant": "partner-co",
"suggested_target_project": "forecasts",
"suggested_target_model": "acme_revenue_forecast",
"created_at": "2026-04-28T10:00:00+00:00"
}
  • Module: Sharing
  • Requires authentication via API token or Auth0 JWT.