Skip to content

project_update

Managementcatalog

Update Project

Not in the default tool list

This tool lives in the tool catalog. Discover it with scenario_tools_search (or enumerate everything with scenario_tools_list) and run it via scenario_tool_execute_write. To list every tool directly, connect with ?toolsets=full.

Rename a Scenario project or change its description, privacy mode or avatar. Only the fields you pass change. Needs project admin (or team admin) rights. Returns: { project, member_count, api_key_count } after the update. Example: "Rename this project to Spring Campaign 2027 and describe it" -> project_id="proj_xyz789", name="Spring Campaign 2027", description="Key art and social assets for the spring launch.". Don't use when: changing who can access the project — use project_members_add / project_members_update / project_members_remove; model allowlists and blocklists — use model_access_update; credit caps — the Scenario web app.
open-world

Parameters

NameTypeRequiredDescription
team_idstring—Team ID. Required with project_id for OAuth callers; an API key is scoped by the key.
project_idstring✓Project ID. Get it from projects_list.
namestring—New project name.
descriptionunknown—Markdown description of the project, up to 2000 characters. null clears it.
privacy_modeboolean—When true, non-admin members see only the assets and models they created (project and team admins see everything). Setting it to false shows every member all existing assets and models: confirm with the user first.
avatar_asset_idstring—ID of an image asset readable from this project to use as its avatar. The avatar can be replaced but not removed.
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.

Example Request

JSON
{
  "team_id": "team_abc123",
  "project_id": "proj_spring01",
  "name": "Spring Campaign 2027",
  "description": "Key art and social assets for the spring launch."
}

Example Response

JSON
{
  "project": {
    "id": "proj_spring01",
    "name": "Spring Campaign 2027",
    "description": "Key art and social assets for the spring launch."
  },
  "member_count": 1,
  "api_key_count": 0
}

Common Use Cases

  • Rename a project or keep its description in sync with the brief
  • Set an image asset as the project avatar