Retrieve

client.teams.brief.retrieve(, ?): BriefRetrieveResponse { brief }

GET/teams/{teamId}/brief

Get the team’s Quality Gate brief

ParametersExpand Collapse

teamID: string

ReturnsExpand Collapse

BriefRetrieveResponse { brief }

brief: Brief { id, body, createdAt, 7 more }

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

id: string

Stable identifier derived from level + scopeId

body: string

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

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the brief

enabled: boolean

Whether the brief is applied during verification

level: "project" | "team"

Scope this brief applies to: team or project

One of the following:

"project"

"team"

referenceAssetIds: Array<string>

Reference assets the verifier compares the image against

scopeId: string

The id of the team or project that owns this brief

updatedAt: string

ISO-8601 last-update timestamp

sensitivity?: "high" | "low" | "medium"

Threshold strictness applied when verifying against this scope

One of the following:

"high"

"low"

"medium"

Retrieve

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const brief = await client.teams.brief.retrieve('teamId');

console.log(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"
  }
}