Retrieve Limits

teams.retrieve_limits() -> TeamRetrieveLimitsResponse

GET/teams/{teamId}/limits

Retrieve current limits for a team

ParametersExpand Collapse

team_id: str

ReturnsExpand Collapse

class TeamRetrieveLimitsResponse: …

limits: Limits

The actual billing limits values related to the plan

api_keys: float

canvas_asset_layers: float

canvas_assets: float

collections: float

creative_units: float

The amount of Compute Units available for the plan

default_seats: float

download_assets: float

download_model: float

inference_batch_size: float

max_cooldown: float

The maximum cooldown applied in case of over head

max_training_datasets: float

min_cooldown: float

The minimum cooldown applied in case of over head

models: float

The maximum models a project can have (train/upload/copy/transfer/…)

otp_sessions: float

parallel_custom_jobs: float

parallel_inferences: float

parallel_training: float

parallel_workflow_runs: float

premium_generation_samples: float

projects: float

The maximum projects a team can have

scaling_factor: float

seats: float

snapshots_retention: float

upload: float

one_shot_creative_units: List[OneShotCreativeUnit]

The list of one-shot Compute Units

Can be empty if the team has no one-shot Compute Units

amount: float

The Compute Units amount bought

created_at: str

The creation date of the Compute Units (buy date) ISO string

expiration: str

The expiration date of the Compute Units ISO string

remaining: float

The remaining Compute Units available

updated_at: str

The last update date of the Compute Units (use date) ISO string

period: Period

The actual billing period start and end dates ISO strings

end: str

start: str

plan: Literal["cu-basic", "cu-creator", "cu-max", 9 more]

The actual plan of the team

One of the following:

"cu-basic"

"cu-creator"

"cu-max"

"cu-pro"

"cu-pro-q3-25"

"cu-team"

"cu-team-v2"

"enterprise"

"essential"

"free"

"premium"

"pro"

values: Values

The current value for each relevant limit in the billing period

api_keys: float

canvas_assets: float

collections: float

creative_units: float

projects: float

seats: float

Retrieve Limits

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
response = client.teams.retrieve_limits(
    "teamId",
)
print(response.limits)

{
  "limits": {
    "apiKeys": 0,
    "canvasAssetLayers": 0,
    "canvasAssets": 0,
    "collections": 0,
    "creativeUnits": 0,
    "defaultSeats": 0,
    "downloadAssets": 0,
    "downloadModel": 0,
    "inferenceBatchSize": 0,
    "maxCooldown": 0,
    "maxTrainingDatasets": 0,
    "minCooldown": 0,
    "models": 0,
    "OTPSessions": 0,
    "parallelCustomJobs": 0,
    "parallelInferences": 0,
    "parallelTraining": 0,
    "parallelWorkflowRuns": 0,
    "premiumGenerationSamples": 0,
    "projects": 0,
    "scalingFactor": 0,
    "seats": 0,
    "snapshotsRetention": 0,
    "upload": 0
  },
  "oneShotCreativeUnits": [
    {
      "amount": 0,
      "createdAt": "createdAt",
      "expiration": "expiration",
      "remaining": 0,
      "updatedAt": "updatedAt"
    }
  ],
  "period": {
    "end": "end",
    "start": "start"
  },
  "plan": "cu-basic",
  "values": {
    "apiKeys": 0,
    "canvasAssets": 0,
    "collections": 0,
    "creativeUnits": 0,
    "projects": 0,
    "seats": 0
  }
}

Returns Examples

{
  "limits": {
    "apiKeys": 0,
    "canvasAssetLayers": 0,
    "canvasAssets": 0,
    "collections": 0,
    "creativeUnits": 0,
    "defaultSeats": 0,
    "downloadAssets": 0,
    "downloadModel": 0,
    "inferenceBatchSize": 0,
    "maxCooldown": 0,
    "maxTrainingDatasets": 0,
    "minCooldown": 0,
    "models": 0,
    "OTPSessions": 0,
    "parallelCustomJobs": 0,
    "parallelInferences": 0,
    "parallelTraining": 0,
    "parallelWorkflowRuns": 0,
    "premiumGenerationSamples": 0,
    "projects": 0,
    "scalingFactor": 0,
    "seats": 0,
    "snapshotsRetention": 0,
    "upload": 0
  },
  "oneShotCreativeUnits": [
    {
      "amount": 0,
      "createdAt": "createdAt",
      "expiration": "expiration",
      "remaining": 0,
      "updatedAt": "updatedAt"
    }
  ],
  "period": {
    "end": "end",
    "start": "start"
  },
  "plan": "cu-basic",
  "values": {
    "apiKeys": 0,
    "canvasAssets": 0,
    "collections": 0,
    "creativeUnits": 0,
    "projects": 0,
    "seats": 0
  }
}