Skip to content

model_access_get

Managementcatalog

Get Model Access Control

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_read. To list every tool directly, connect with ?toolsets=full.

Get a team's model access control: the models-management mode plus the team-level model list, and one project's list when project_id is given. With include_models, team admins also get the catalog, every model with its access status, to choose what to pass to model_access_update. Semantics: in blocklist mode (the default) every catalog model is available except those in the team or project blocklist (the union blocks). In allowlist mode only models in BOTH the team and project allowlists are available; a project with an empty or unset allowlist denies every model. include_models (OAuth team admins only; API keys and other members are refused, because the API filters their catalog): lists public (default) or private models a page at a time, as the web app's model settings pages show them. Each model carries access: { team: 'enabled' | 'disabled', project?: 'enabled' | 'disabled' | 'locked_by_team', override? }. locked_by_team means the team list excludes it, so it must be enabled at team level first; override means the team allows it but the project does not. Filter with modality, capability and access_status ('disabled' answers "what can I enable"). Follow nextPaginationToken until it is absent. Returns: { models_management ('blocklist' | 'allowlist'), team: {models, count}, project?: {project_id, configured, models, count}, auto_allowlist_trained_models? (allowlist mode only), models?: [{id, name, type, privacy, capabilities, access}], nextPaginationToken?, note }. Only the mode's active list is returned; the inactive stored list is never surfaced. Examples: - "Which models are blocked for project X?" -> team_id="team_xxx", project_id="project_xxx" - "Which models can I still enable here?" -> include_models=true, access_status="disabled" Don't use when: you want to change the lists, use model_access_update (catalog-only, run via scenario_tool_execute_write).
read-onlyidempotentopen-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. Include to also return that project's list. OAuth sessions always pass it as tenant context, so their result covers it.
include_modelsboolean—Team admins (OAuth) only: also list the catalog models, each with its access status, including models the lists exclude.
privacyenum(public | private)publicWith include_models: 'public' (platform models, default) or 'private' (the team's own models).
modalityenum(image | video | 3d | audio)—With include_models: keep models of this output modality.
capabilitystring—With include_models: keep models with this capability (e.g. txt2img).
access_statusenum(enabled | disabled)—With include_models: keep models usable ('enabled') or not ('disabled') in the project when project_id is given, else team-wide.
limitnumber50With include_models: models per API page read.
page_tokenstring—With include_models: nextPaginationToken from the previous call.
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.