API Reference

Teams

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Brief

Delete

client.teams.brief.delete(stringteamID, RequestOptionsoptions?): BriefDeleteResponse { deleted }

DELETE/teams/{teamId}/brief

Retrieve

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

GET/teams/{teamId}/brief

Update

client.teams.brief.update(stringteamID, BriefUpdateParams { body, enabled, referenceAssetIds, sensitivity } body, RequestOptionsoptions?): BriefUpdateResponse { brief }

PUT/teams/{teamId}/brief

ModelsExpand Collapse

BriefDeleteResponse { deleted }

deleted: boolean

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"

BriefUpdateResponse { 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"