Skip to content
Get started

Brief

Delete
DELETE/projects/{projectId}/brief
Retrieve
GET/projects/{projectId}/brief
Update
PUT/projects/{projectId}/brief
ModelsExpand Collapse
BriefDeleteResponse object { deleted }
deleted: boolean
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

One of the following:
"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

One of the following:
"high"
"low"
"medium"
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

One of the following:
"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

One of the following:
"high"
"low"
"medium"