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 model. Requires Pro plan. Pass source_workspace_id to share a model from a workspace other than your current one — distinct from target_tenant_slug, which names the (different) tenant being shared with.

Parameters

Name	Type	Required	Default	Description
source_model_name	Annotated[str, Field(description='Name of the source Bridge Town model.')]	Yes	—
script_name	Annotated[str, Field(description='Name of the model file to share (without .py extension).')]	Yes	—
target_tenant_slug	Annotated[str, Field(description='Slug identifier of the target workspace to share the model with.')]	Yes	—
suggested_target_model	Annotated[str, Field(description='Suggested model name in the target workspace where the model file should be placed.')]	Yes	—
suggested_target_script	Annotated[str, Field(description='Suggested name for the model file in the target workspace.')]	No	''
source_workspace_id	`Annotated[str	None, Field(description=‘Optional UUID of a workspace other than your current one that holds the source model. Omit to use your current workspace. Cross-workspace targeting requires an active membership in that workspace and is only available to OAuth/JWT sessions — API tokens stay scoped to their issuing workspace. This is distinct from target_tenant_slug, which names the (different) tenant the model is being shared with. The response echoes source_workspace_id so you can reuse it on follow-up calls.’)]`	No	None

Returns

Returns a structured object. Top-level fields:

• request_id (string)
• status (string)
• source_model (string)
• source_script (string)
• target_tenant (string)
• suggested_target_model (string)
• suggested_target_script (string)
• created_at (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "request_model_share",
  "arguments": {
    "source_model_name": "platform",
    "script_name": "revenue_forecast",
    "target_tenant_slug": "partner-co",
    "suggested_target_model": "forecasts",
    "suggested_target_script": "acme_revenue_forecast"
  }
}

Response

{
  "request_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "status": "pending",
  "source_model": "platform",
  "source_script": "revenue_forecast",
  "target_tenant": "partner-co",
  "suggested_target_model": "forecasts",
  "suggested_target_script": "acme_revenue_forecast",
  "created_at": "2026-04-28T10:00:00+00:00"
}

Notes

• Module: Sharing
• Requires authentication via API token or Auth0 JWT.