Skip to content
SupaCloud Docs
Select themeSelect language

get_api_management_v1_workspaces_slug_state

GET
/api/management/v1/workspaces/{slug}/state

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Sanitized workspace state

Media typeapplication/json
object
agent_profiles
required

#998 — the workspace’s agent profiles, so an M2M caller can check a pin BEFORE launching instead of discovering a bad one as a 400. Deliberately the SHARED AgentProfileSummary projection rather than a management-local DTO: the decision about which profile columns may leave the instance is made once, in sc-svc-tenancy::agent_profiles_summary, so this surface and the profile.* MCP tools cannot drift apart. READ-ONLY — the apply (PUT) side takes a different struct (ManagementWorkspaceState) and ignores unknown sections, so this can never become a write path.

Array<object>

The outward-facing view of one agent profile: identity, lifecycle and what the profile PINS. Deliberately free of prompts, allowlists and open config bags — see the module header.

object
created_at
required
string format: date-time
default_agent_type
required

The harness the profile runs (claude, codex, …).

string
description
string | null
effort_default
string | null
enabled
required

A disabled profile still resolves by id/slug, so a caller checking a pin must be able to see that it would not actually be selectable.

boolean
execution_mode
required
string
fixed_model
string | null
id
required
string format: uuid
is_workspace_default
required
boolean
model_policy
required

fixed | auto | … — together with fixed_model this is the answer to “which model does a task pinned to this profile actually get?”.

string
name
required
string
review_required
required
boolean
slug
required
string
tags
required
Array<string>
updated_at
required
string format: date-time
version
required

Bumped on every profile edit — lets a caller detect that the thing it verified earlier is no longer the thing it is launching against.

integer format: int32
ai_credentials
required
Array<object>
object
account_email
string | null
expires_at
string | null format: date-time
fingerprint
string | null
id
required
string format: uuid
key
required
string
provider
string | null
scope
required
string
budget
One of:
null
git_credentials
required
Array<object>
object
account_email
string | null
expires_at
string | null format: date-time
fingerprint
string | null
id
required
string format: uuid
key
required
string
provider
string | null
scope
required
string
invites
required
Array<object>
object
email
required
string
role
required
string
mailbox_credentials
required
Array<object>
object
account_email
string | null
expires_at
string | null format: date-time
fingerprint
string | null
id
required
string format: uuid
key
required
string
provider
string | null
scope
required
string
members
required
Array<object>
object
admin
boolean
approved
boolean
display_name
string | null
email
required
string
role
required
string
oauth_credentials
required
Array<object>
object
account_email
string | null
expires_at
string | null format: date-time
fingerprint
string | null
id
required
string format: uuid
key
required
string
provider
string | null
scope
required
string
projects
required
Array<object>
object
git_provider
string | null
git_repo_url
string | null
id
required
string format: uuid
key
required
string
name
required
string
schedules
required
Array<object>
object
agent_type
required
string
cadence
required
string
id
required
string format: uuid
interval_minutes
required

#908 — the step width of an interval cadence in minutes; null for calendar cadences.

integer | null format: int32
key
required
string
next_run_at
string | null format: date-time
status
required
string
title
required
string
tasks
required
Array<object>
object
agent_type
required
string
id
required
string format: uuid
key
required
string
project_id
string | null format: uuid
status
required
string
title
required
string
variables
required
Array<object>
object
created_at
required
string format: date-time
fingerprint
string | null
id
required
string format: uuid
is_secret
required
boolean
key
required
string
project_id
string | null format: uuid
value
required
string
workspace
required
object
id
required
string format: uuid
name
required
string
owner_id
required
string format: uuid
slug
required
string
Examplegenerated
{
  "agent_profiles": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "default_agent_type": "example",
      "description": "example",
      "effort_default": "example",
      "enabled": true,
      "execution_mode": "example",
      "fixed_model": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "is_workspace_default": true,
      "model_policy": "example",
      "name": "example",
      "review_required": true,
      "slug": "example",
      "tags": [
        "example"
      ],
      "updated_at": "2026-04-15T12:00:00Z",
      "version": 1
    }
  ],
  "ai_credentials": [
    {
      "account_email": "example",
      "expires_at": "2026-04-15T12:00:00Z",
      "fingerprint": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "provider": "example",
      "scope": "example"
    }
  ],
  "budget": {
    "alerts": [
      "example"
    ],
    "api_mode_controls": {
      "additionalProperty": true
    },
    "connected_subscriptions": [
      {
        "account_email": "example",
        "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "plan_label": "example",
        "provider": "example",
        "quota_readability": "example"
      }
    ],
    "critical_threshold_percent": 1,
    "effective_month_spend_usd": 1,
    "fill_target": 1,
    "hard_stop": true,
    "inflight_reserved_usd": 1,
    "month_spend_usd": 1,
    "monthly_cap_usd": 1,
    "per_provider_summary": [
      {
        "account_count": 1,
        "fill_pct": 1,
        "limit": 1,
        "provider": "example",
        "scope": "example",
        "used": 1,
        "window_type": "example"
      }
    ],
    "per_provider_windows": [
      {
        "account_email": "example",
        "account_role": "example",
        "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "credential_type": "example",
        "fill_pct": 1,
        "limit": 1,
        "measured_at": "2026-04-15T12:00:00Z",
        "measurement": "example",
        "minutes_to_refresh": 1,
        "plan_label": "example",
        "provider": "example",
        "reset_credits": 1,
        "resets_at": "2026-04-15T12:00:00Z",
        "scope": "example",
        "source": "example",
        "throttling_soon": true,
        "used": 1,
        "window_start": "2026-04-15T12:00:00Z",
        "window_type": "example"
      }
    ],
    "provider_inflight_reserved_usd": {
      "additionalProperty": 1
    },
    "provider_monthly_caps_usd": {
      "additionalProperty": 1
    },
    "provider_spend_usd": {
      "additionalProperty": 1
    },
    "remaining_usd": 1,
    "status": "example",
    "threshold_alerts_percent": [
      1
    ],
    "warning_threshold_percent": 1
  },
  "git_credentials": [
    {
      "account_email": "example",
      "expires_at": "2026-04-15T12:00:00Z",
      "fingerprint": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "provider": "example",
      "scope": "example"
    }
  ],
  "invites": [
    {
      "email": "example",
      "role": "example"
    }
  ],
  "mailbox_credentials": [
    {
      "account_email": "example",
      "expires_at": "2026-04-15T12:00:00Z",
      "fingerprint": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "provider": "example",
      "scope": "example"
    }
  ],
  "members": [
    {
      "admin": true,
      "approved": true,
      "display_name": "example",
      "email": "example",
      "role": "example"
    }
  ],
  "oauth_credentials": [
    {
      "account_email": "example",
      "expires_at": "2026-04-15T12:00:00Z",
      "fingerprint": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "provider": "example",
      "scope": "example"
    }
  ],
  "projects": [
    {
      "git_provider": "example",
      "git_repo_url": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "name": "example"
    }
  ],
  "schedules": [
    {
      "agent_type": "example",
      "cadence": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "interval_minutes": 1,
      "key": "example",
      "next_run_at": "2026-04-15T12:00:00Z",
      "status": "example",
      "title": "example"
    }
  ],
  "tasks": [
    {
      "agent_type": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "status": "example",
      "title": "example"
    }
  ],
  "variables": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "fingerprint": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "is_secret": true,
      "key": "example",
      "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "value": "example"
    }
  ],
  "workspace": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "owner_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "slug": "example"
  }
}