Update

projects.brief.update(, ) -> BriefUpdateResponse

PUT/projects/{projectId}/brief

Create or update the project’s Quality Gate brief

ParametersExpand Collapse

project_id: str

body: str

Free-text brief content

maxLength8000

minLength1

enabled: Optional[bool]

Whether the brief is applied during verification (default true)

reference_asset_ids: Optional[Sequence[str]]

Reference assets the verifier compares against (max 10). Send [] to clear.

sensitivity: Optional[Literal["high", "low", "medium"]]

Threshold strictness stored for this scope: low, medium, or high. Applied to verifications unless the verify call passes its own sensitivity.

One of the following:

"high"

"low"

"medium"

ReturnsExpand Collapse

class BriefUpdateResponse: …

brief: Brief

A brand-style / project-rules / campaign-context brief stored at one scope.

id: str

Stable identifier derived from level + scopeId

body: str

Free-text brief: brand style, rules, campaign context

created_at: str

ISO-8601 creation timestamp

created_by: str

User id that last wrote the brief

enabled: bool

Whether the brief is applied during verification

level: Literal["project", "team"]

Scope this brief applies to: team or project

One of the following:

"project"

"team"

reference_asset_ids: List[str]

Reference assets the verifier compares the image against

scope_id: str

The id of the team or project that owns this brief

updated_at: str

ISO-8601 last-update timestamp

sensitivity: Optional[Literal["high", "low", "medium"]]

Threshold strictness applied when verifying against this scope

One of the following:

"high"

"low"

"medium"

Update

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
)
brief = client.projects.brief.update(
    project_id="projectId",
    body="x",
)
print(brief.brief)

{
  "brief": {
    "id": "id",
    "body": "body",
    "createdAt": "createdAt",
    "createdBy": "createdBy",
    "enabled": true,
    "level": "project",
    "referenceAssetIds": [
      "string"
    ],
    "scopeId": "scopeId",
    "updatedAt": "updatedAt",
    "sensitivity": "high"
  }
}

Returns Examples

{
  "brief": {
    "id": "id",
    "body": "body",
    "createdAt": "createdAt",
    "createdBy": "createdBy",
    "enabled": true,
    "level": "project",
    "referenceAssetIds": [
      "string"
    ],
    "scopeId": "scopeId",
    "updatedAt": "updatedAt",
    "sensitivity": "high"
  }
}