# Brief

## Delete

**delete** `/projects/{projectId}/brief`

Delete the project's Quality Gate brief

### Path Parameters

- `projectId: string`

### Returns

- `deleted: boolean`

### Example

```http
curl https://api.cloud.scenario.com/v1/projects/$PROJECT_ID/brief \
    -X DELETE \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET"
```

#### Response

```json
{
  "deleted": true
}
```

## Retrieve

**get** `/projects/{projectId}/brief`

Get the project's Quality Gate brief

### Path Parameters

- `projectId: string`

### Returns

- `brief: object { 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" or "team"`

    Scope this brief applies to: team or project

    - `"project"`

    - `"team"`

  - `referenceAssetIds: array of 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: optional "high" or "low" or "medium"`

    Threshold strictness applied when verifying against this scope

    - `"high"`

    - `"low"`

    - `"medium"`

### Example

```http
curl https://api.cloud.scenario.com/v1/projects/$PROJECT_ID/brief \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET"
```

#### Response

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

## Update

**put** `/projects/{projectId}/brief`

Create or update the project's Quality Gate brief

### Path Parameters

- `projectId: string`

### Body Parameters

- `body: string`

  Free-text brief content

- `enabled: optional boolean`

  Whether the brief is applied during verification (default true)

- `referenceAssetIds: optional array of string`

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

- `sensitivity: optional "high" or "low" or "medium"`

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

  - `"high"`

  - `"low"`

  - `"medium"`

### Returns

- `brief: object { 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" or "team"`

    Scope this brief applies to: team or project

    - `"project"`

    - `"team"`

  - `referenceAssetIds: array of 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: optional "high" or "low" or "medium"`

    Threshold strictness applied when verifying against this scope

    - `"high"`

    - `"low"`

    - `"medium"`

### Example

```http
curl https://api.cloud.scenario.com/v1/projects/$PROJECT_ID/brief \
    -X PUT \
    -H 'Content-Type: application/json' \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET" \
    -d '{
          "body": "x"
        }'
```

#### Response

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

## Domain Types

### Brief Delete Response

- `BriefDeleteResponse object { deleted }`

  - `deleted: boolean`

### Brief Retrieve Response

- `BriefRetrieveResponse object { brief }`

  - `brief: object { 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" or "team"`

      Scope this brief applies to: team or project

      - `"project"`

      - `"team"`

    - `referenceAssetIds: array of 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: optional "high" or "low" or "medium"`

      Threshold strictness applied when verifying against this scope

      - `"high"`

      - `"low"`

      - `"medium"`

### Brief Update Response

- `BriefUpdateResponse object { brief }`

  - `brief: object { 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" or "team"`

      Scope this brief applies to: team or project

      - `"project"`

      - `"team"`

    - `referenceAssetIds: array of 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: optional "high" or "low" or "medium"`

      Threshold strictness applied when verifying against this scope

      - `"high"`

      - `"low"`

      - `"medium"`