Teams

Delete Invitations

client.teams.deleteInvitations(, , ?): TeamDeleteInvitationsResponse

DELETE/teams/{teamId}/invitations

List

client.teams.list(?): TeamListResponse { teams }

GET/teams

Retrieve

client.teams.retrieve(, ?): TeamRetrieveResponse { team }

GET/teams/{teamId}

Retrieve Limits

client.teams.retrieveLimits(, ?): TeamRetrieveLimitsResponse { limits, oneShotCreativeUnits, period, 2 more }

GET/teams/{teamId}/limits

Update

client.teams.update(, , ?): TeamUpdateResponse { team }

PUT/teams/{teamId}

ModelsExpand Collapse

TeamDeleteInvitationsResponse = unknown

TeamListResponse { teams }

teams: Array<Team>

A list of the teams the user belongs to

id: string

The team ID (example: “eyVcnFJcR92BxBkz7N6g5w”)

context: Context { invitationsCount, keysCount, userRole, usersCount }

The context of the team for the current authenticated user

invitationsCount: number

The number of invitations on this team

keysCount: number

The number of API keys on this team

userRole: "admin" | "key" | "member"

The authenticated user’s role for this team

One of the following:

"admin"

"key"

"member"

usersCount: number

The number of users on this team

createdAt: string

The team creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

The team name (example: “Scenario”)

plan: "cu-basic" | "cu-creator" | "cu-max" | 9 more

The team plan

One of the following:

"cu-basic"

"cu-creator"

"cu-max"

"cu-pro"

"cu-pro-q3-25"

"cu-team"

"cu-team-v2"

"enterprise"

"essential"

"free"

"premium"

"pro"

projects: Array<Project>

Projects of the team

id: string

createdAt: string

updatedAt: string

avatar?: Avatar { assetId, url }

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

disableIpDetection?: boolean

When true, IP detection is switched off for this project.

qualityGateAutoDetect?: boolean

Whether Quality Gate auto-detection runs on generation for this project.

type: "personal" | "shared"

The team type

One of the following:

"personal"

"shared"

updatedAt: string

The team update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

avatar?: Avatar { assetId, url }

The team’s avatar

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

byok?: Byok { markupMultiplier, updatedAt, updatedBy }

BYOK pricing override. Admin-only — omitted for non-admin callers.

markupMultiplier: number

updatedAt?: string

ISO timestamp of the last update. Optional — legacy rows may lack it.

updatedBy?: string

Human-readable handle of who last updated the markup (display name).

defaultUserMaxConsumption?: number

Team-wide default max consumption (CU) applied to every member over the billing period, unless overridden per member. Absent when no team-wide default is set.

ipDetectionEnforcement?: "active-fail-closed" | "active-fail-open" | "disabled"

The IP detection enforcement posture for the team. ‘disabled’: IP detection is not performed. ‘active-fail-open’: IP detection runs; on detector error the request is allowed through. ‘active-fail-closed’: IP detection runs; on detector error the request is blocked.

One of the following:

"active-fail-closed"

"active-fail-open"

"disabled"

qualityGateAutoDetect?: boolean

Quality Gate auto-detection default for the team.

TeamRetrieveResponse { team }

team: Team { id, createdAt, invitations, 17 more }

id: string

The team ID (example: “eyVcnFJcR92BxBkz7N6g5w”)

createdAt: string

The team creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

invitations: Array<Invitation>

The list of pending invitations

createdAt: string

The user creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

email: string

The invited user email (example: “herve@scenario.com”)

role: "admin" | "key" | "member"

The role of the invited user inside the team

One of the following:

"admin"

"key"

"member"

status: "accepted" | "expired" | "pending" | "withdrawn"

The status of the invitation

One of the following:

"accepted"

"expired"

"pending"

"withdrawn"

url: string

The link the invited user opens to accept the invitation, as sent by email

projectIds?: Array<string>

The list of project IDs for which the user is invited

keys: Array<Key>

The list of API keys

id: string

The key’s member id (its API user id, apiu_...), taken by the member and usage routes (example: “apiu_eyVcnFJcR92BxBkz7N6g5w”)

apiKeyId: string

The API key id (api_...), taken by the api-keys routes (example: “api_eyVcnFJcR92BxBkz7N6g5w”)

apiKeyStatus: "active" | "inactive"

The status of the API key

One of the following:

"active"

"inactive"

createdAt: string

The API key creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

The API key name (example: “eurv-scenario”)

scope: "project" | "team"

The scope of the API key: ‘project’ for project-scoped keys, ‘team’ for team-scoped keys

One of the following:

"project"

"team"

updatedAt: string

The API key last update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

authorId?: string

The member who created the key: a human, or the member id (apiu_...) of the team API key that created it.

consumption?: number

Consumption (CU) used by this key over the current billing period.

lastUsedAt?: string

The date the API key was last used to authenticate a request, as an ISO string (example: “2023-02-03T11:19:41.579Z”). Absent if the key has never been used.

maxConsumption?: number

The key’s effective consumption (CU) cap for the period (per-key override, else the team-wide default). Absent when the key is uncapped.

ownerId?: string

For a PROJECT key: the project it was created on (the team id on some legacy keys). Absent for team keys.

projects?: Array<Project>

For a PROJECT key: the projects it has access to and its role on each. Empty when the key is currently not a member of any (live) project. Absent for team keys.

projectId: string

The project the key has a role on

role: string

The key’s role on this project: a built-in role (admin/editor/reader) or a custom ;-separated scope list (example: "asset.read;model.read").

role?: string

The key’s role. For a TEAM key: its effective team-plane scopes as a ;-separated list (e.g. "team.read;team.usage.read"). Project keys carry their project-plane role(s) per project in projects instead.

The team name (example: “Scenario”)

paymentStatus: "failed" | "succeeded"

The paymentStatus for the team

One of the following:

"failed"

"succeeded"

plan: "cu-basic" | "cu-creator" | "cu-max" | 9 more

The team plan

One of the following:

"cu-basic"

"cu-creator"

"cu-max"

"cu-pro"

"cu-pro-q3-25"

"cu-team"

"cu-team-v2"

"enterprise"

"essential"

"free"

"premium"

"pro"

projects: Array<Project>

Projects of the team

id: string

createdAt: string

updatedAt: string

avatar?: Avatar { assetId, url }

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

disableIpDetection?: boolean

When true, IP detection is switched off for this project.

qualityGateAutoDetect?: boolean

Whether Quality Gate auto-detection runs on generation for this project.

searchHost: string

The search host for the team

searchIndexes: SearchIndexes { assets, models, workflows }

The search indexes for the team

assets: Assets { private, public }

private: string

The private search index for the team

public: string

The public search index for the team

models: Models { private, public }

private: string

The private search index for the team

public: string

The public search index for the team

workflows: Workflows { private, public }

private: string

The private search index for the team

public: string

The public search index for the team

type: "personal" | "shared"

The team type

One of the following:

"personal"

"shared"

updatedAt: string

The team update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

users: Array<User>

The list of teams members and their role

id: string

The user ID (example: “eyVcnFJcR92BxBkz7N6g5w”)

createdAt: string

The user creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

email: string

The user email (example: “herve@scenario.com”)

role: "admin" | "key" | "member"

The role of the user inside the team

One of the following:

"admin"

"key"

"member"

updatedAt: string

The user last update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

avatar?: Avatar { assetId, url }

The user’s avatar

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

consumption?: number

Consumption (CU) used by this member over the current billing period.

maxConsumption?: number

The member’s effective consumption (CU) cap for the period (per-user override, else the team-wide default). Absent when the member is uncapped.

avatar?: Avatar { assetId, url }

The team’s avatar

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

byok?: Byok { markupMultiplier, updatedAt, updatedBy }

BYOK pricing override. Admin-only — omitted for non-admin callers.

markupMultiplier: number

updatedAt?: string

ISO timestamp of the last update. Optional — legacy rows may lack it.

updatedBy?: string

Human-readable handle of who last updated the markup (display name).

defaultUserMaxConsumption?: number

Team-wide default max consumption (CU) applied to every member over the billing period, unless overridden per member. Absent when no team-wide default is set.

ipDetectionEnforcement?: "active-fail-closed" | "active-fail-open" | "disabled"

One of the following:

"active-fail-closed"

"active-fail-open"

"disabled"

qualityGateAutoDetect?: boolean

Quality Gate auto-detection default for the team.

settings?: Settings { homepage }

Team settings. Returned on GET and PUT /teams/{teamId}, absent from the teams list.

homepage?: Record<string, unknown>

Published homepage layout.

subscriptionStatus?: "active" | "inactive" | "paused"

The subscriptionStatus for the team

One of the following:

"active"

"inactive"

"paused"

TeamRetrieveLimitsResponse { limits, oneShotCreativeUnits, period, 2 more }

limits: Limits { apiKeys, canvasAssetLayers, canvasAssets, 21 more }

The actual billing limits values related to the plan

apiKeys: number

canvasAssetLayers: number

canvasAssets: number

collections: number

creativeUnits: number

The amount of Compute Units available for the plan

defaultSeats: number

downloadAssets: number

downloadModel: number

inferenceBatchSize: number

maxCooldown: number

The maximum cooldown applied in case of over head

maxTrainingDatasets: number

minCooldown: number

The minimum cooldown applied in case of over head

models: number

The maximum models a project can have (train/upload/copy/transfer/…)

OTPSessions: number

parallelCustomJobs: number

parallelInferences: number

parallelTraining: number

parallelWorkflowRuns: number

premiumGenerationSamples: number

projects: number

The maximum projects a team can have

scalingFactor: number

seats: number

snapshotsRetention: number

upload: number

oneShotCreativeUnits: Array<OneShotCreativeUnit>

The list of one-shot Compute Units

Can be empty if the team has no one-shot Compute Units

amount: number

The Compute Units amount bought

createdAt: string

The creation date of the Compute Units (buy date) ISO string

expiration: string

The expiration date of the Compute Units ISO string

remaining: number

The remaining Compute Units available

updatedAt: string

The last update date of the Compute Units (use date) ISO string

period: Period { end, start }

The actual billing period start and end dates ISO strings

end: string

start: string

plan: "cu-basic" | "cu-creator" | "cu-max" | 9 more

The actual plan of the team

One of the following:

"cu-basic"

"cu-creator"

"cu-max"

"cu-pro"

"cu-pro-q3-25"

"cu-team"

"cu-team-v2"

"enterprise"

"essential"

"free"

"premium"

"pro"

values: Values { apiKeys, canvasAssets, collections, 3 more }

The current value for each relevant limit in the billing period

apiKeys: number

canvasAssets: number

collections: number

creativeUnits: number

projects: number

seats: number

TeamUpdateResponse { team }

team: Team { id, context, createdAt, 11 more }

The updated team.

id: string

The team ID (example: “eyVcnFJcR92BxBkz7N6g5w”)

context: Context { invitationsCount, keysCount, userRole, usersCount }

The context of the team for the current authenticated user

invitationsCount: number

The number of invitations on this team

keysCount: number

The number of API keys on this team

userRole: "admin" | "key" | "member"

The authenticated user’s role for this team

One of the following:

"admin"

"key"

"member"

usersCount: number

The number of users on this team

createdAt: string

The team creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

The team name (example: “Scenario”)

plan: "cu-basic" | "cu-creator" | "cu-max" | 9 more

The team plan

One of the following:

"cu-basic"

"cu-creator"

"cu-max"

"cu-pro"

"cu-pro-q3-25"

"cu-team"

"cu-team-v2"

"enterprise"

"essential"

"free"

"premium"

"pro"

projects: Array<Project>

Projects of the team

id: string

createdAt: string

updatedAt: string

avatar?: Avatar { assetId, url }

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

disableIpDetection?: boolean

When true, IP detection is switched off for this project.

qualityGateAutoDetect?: boolean

Whether Quality Gate auto-detection runs on generation for this project.

type: "personal" | "shared"

The team type

One of the following:

"personal"

"shared"

updatedAt: string

The team update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

avatar?: Avatar { assetId, url }

The team’s avatar

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

byok?: Byok { markupMultiplier, updatedAt, updatedBy }

BYOK pricing override. Admin-only — omitted for non-admin callers.

markupMultiplier: number

updatedAt?: string

ISO timestamp of the last update. Optional — legacy rows may lack it.

updatedBy?: string

Human-readable handle of who last updated the markup (display name).

defaultUserMaxConsumption?: number

Team-wide default max consumption (CU) applied to every member over the billing period, unless overridden per member. Absent when no team-wide default is set.

ipDetectionEnforcement?: "active-fail-closed" | "active-fail-open" | "disabled"

One of the following:

"active-fail-closed"

"active-fail-open"

"disabled"

qualityGateAutoDetect?: boolean

Quality Gate auto-detection default for the team.

settings?: Settings { homepage }

Team settings.

homepage?: Record<string, unknown>

Published homepage layout.

TeamsBrief

Delete

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

DELETE/teams/{teamId}/brief

Retrieve

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

GET/teams/{teamId}/brief

Update

client.teams.brief.update(, , ?): 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"

TeamsIP Filters

Create

client.teams.ipFilters.create(, , ?): IPFilterCreateResponse { filter }

POST/teams/{teamId}/ip-filters

Delete

client.teams.ipFilters.delete(, , ?): IPFilterDeleteResponse { deleted }

DELETE/teams/{teamId}/ip-filters/{filterId}

Draft Instruction

client.teams.ipFilters.draftInstruction(, , ?): IPFilterDraftInstructionResponse { instruction }

POST/teams/{teamId}/ip-filters/draft-instruction

List

client.teams.ipFilters.list(, ?): IPFilterListResponse { filters }

GET/teams/{teamId}/ip-filters

Update

client.teams.ipFilters.update(, , ?): IPFilterUpdateResponse { filter }

PUT/teams/{teamId}/ip-filters/{filterId}

ModelsExpand Collapse

IPFilterCreateResponse { filter }

filter: unknown

The created custom filter, including its enabled state

IPFilterDeleteResponse { deleted }

deleted: boolean

True when the filter was deleted

IPFilterDraftInstructionResponse { instruction }

instruction: string

Drafted natural-language detection instruction derived from the reference assets

IPFilterListResponse { filters }

filters: Array<unknown>

Built-in and custom IP-detection filters for the team, each with its enabled state

IPFilterUpdateResponse { filter }

filter: unknown

The updated filter, including its enabled state

TeamsMembers

Create

client.teams.members.create(, , ?): MemberCreateResponse { team }

POST/teams/{teamId}/members

Delete

client.teams.members.delete(, , ?): MemberDeleteResponse

DELETE/teams/{teamId}/members/{memberId}

Update

client.teams.members.update(, , ?): MemberUpdateResponse

PUT/teams/{teamId}/members/{memberId}

ModelsExpand Collapse

MemberCreateResponse { team }

team: Team { id, context, createdAt, 10 more }

id: string

The team ID (example: “eyVcnFJcR92BxBkz7N6g5w”)

context: Context { invitationsCount, keysCount, userRole, usersCount }

The context of the team for the current authenticated user

invitationsCount: number

The number of invitations on this team

keysCount: number

The number of API keys on this team

userRole: "admin" | "key" | "member"

The authenticated user’s role for this team

One of the following:

"admin"

"key"

"member"

usersCount: number

The number of users on this team

createdAt: string

The team creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

The team name (example: “Scenario”)

plan: "cu-basic" | "cu-creator" | "cu-max" | 9 more

The team plan

One of the following:

"cu-basic"

"cu-creator"

"cu-max"

"cu-pro"

"cu-pro-q3-25"

"cu-team"

"cu-team-v2"

"enterprise"

"essential"

"free"

"premium"

"pro"

projects: Array<Project>

Projects of the team

id: string

createdAt: string

updatedAt: string

avatar?: Avatar { assetId, url }

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

disableIpDetection?: boolean

When true, IP detection is switched off for this project.

qualityGateAutoDetect?: boolean

Whether Quality Gate auto-detection runs on generation for this project.

type: "personal" | "shared"

The team type

One of the following:

"personal"

"shared"

updatedAt: string

The team update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

avatar?: Avatar { assetId, url }

The team’s avatar

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

byok?: Byok { markupMultiplier, updatedAt, updatedBy }

BYOK pricing override. Admin-only — omitted for non-admin callers.

markupMultiplier: number

updatedAt?: string

ISO timestamp of the last update. Optional — legacy rows may lack it.

updatedBy?: string

Human-readable handle of who last updated the markup (display name).

defaultUserMaxConsumption?: number

Team-wide default max consumption (CU) applied to every member over the billing period, unless overridden per member. Absent when no team-wide default is set.

ipDetectionEnforcement?: "active-fail-closed" | "active-fail-open" | "disabled"

One of the following:

"active-fail-closed"

"active-fail-open"

"disabled"

qualityGateAutoDetect?: boolean

Quality Gate auto-detection default for the team.

MemberDeleteResponse = unknown

MemberUpdateResponse = unknown

TeamsWatermark

Delete

client.teams.watermark.delete(, ?): WatermarkDeleteResponse { deleted }

DELETE/teams/{teamId}/watermark

Delete Logo

client.teams.watermark.deleteLogo(, ?): WatermarkDeleteLogoResponse { watermark }

DELETE/teams/{teamId}/watermark/logo

Preview

client.teams.watermark.preview(, , ?): WatermarkPreviewResponse { image }

POST/teams/{teamId}/watermark/preview

Retrieve

client.teams.watermark.retrieve(, ?): WatermarkRetrieveResponse { watermark }

GET/teams/{teamId}/watermark

Update

client.teams.watermark.update(, , ?): WatermarkUpdateResponse { watermark }

PUT/teams/{teamId}/watermark

Update Logo

client.teams.watermark.updateLogo(, , ?): WatermarkUpdateLogoResponse { watermark }

PUT/teams/{teamId}/watermark/logo

ModelsExpand Collapse

WatermarkDeleteResponse { deleted }

deleted: boolean

WatermarkDeleteLogoResponse { watermark }

watermark: Watermark { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" | "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

Mark opacity, 0.05 (barely visible) to 1 (opaque)

placement: "bottom-left" | "bottom-right" | "center" | 3 more

Where the mark sits on the image

One of the following:

"bottom-left"

"bottom-right"

"center"

"tiled"

"top-left"

"top-right"

rotation: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt?: string

Set when the configuration has been deleted.

logoIsOpaque?: boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey?: string

Where the uploaded logo lives, when one is set.

text?: string

Text rendered as the mark, when no logo is set

WatermarkPreviewResponse { image }

Response of the watermark preview routes.

image: string

The sample image with the mark drawn on it, base64-encoded.

WatermarkRetrieveResponse { watermark }

watermark: Watermark { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" | "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

Mark opacity, 0.05 (barely visible) to 1 (opaque)

placement: "bottom-left" | "bottom-right" | "center" | 3 more

Where the mark sits on the image

One of the following:

"bottom-left"

"bottom-right"

"center"

"tiled"

"top-left"

"top-right"

rotation: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt?: string

Set when the configuration has been deleted.

logoIsOpaque?: boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey?: string

Where the uploaded logo lives, when one is set.

text?: string

Text rendered as the mark, when no logo is set

WatermarkUpdateResponse { watermark }

watermark: Watermark { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" | "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

Mark opacity, 0.05 (barely visible) to 1 (opaque)

placement: "bottom-left" | "bottom-right" | "center" | 3 more

Where the mark sits on the image

One of the following:

"bottom-left"

"bottom-right"

"center"

"tiled"

"top-left"

"top-right"

rotation: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt?: string

Set when the configuration has been deleted.

logoIsOpaque?: boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey?: string

Where the uploaded logo lives, when one is set.

text?: string

Text rendered as the mark, when no logo is set

WatermarkUpdateLogoResponse { watermark }

watermark: Watermark { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" | "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

Mark opacity, 0.05 (barely visible) to 1 (opaque)

placement: "bottom-left" | "bottom-right" | "center" | 3 more

Where the mark sits on the image

One of the following:

"bottom-left"

"bottom-right"

"center"

"tiled"

"top-left"

"top-right"

rotation: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt?: string

Set when the configuration has been deleted.

logoIsOpaque?: boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey?: string

Where the uploaded logo lives, when one is set.

text?: string

Text rendered as the mark, when no logo is set

TeamsWebhook Endpoints

Create

client.teams.webhookEndpoints.create(, , ?): WebhookEndpointCreateResponse { webhookEndpoint }

POST/teams/{teamId}/webhook-endpoints

Delete

client.teams.webhookEndpoints.delete(, , ?): WebhookEndpointDeleteResponse

DELETE/teams/{teamId}/webhook-endpoints/{webhookEndpointId}

List

client.teams.webhookEndpoints.list(, ?): WebhookEndpointListResponse { webhookEndpoints }

GET/teams/{teamId}/webhook-endpoints

Update

client.teams.webhookEndpoints.update(, , ?): WebhookEndpointUpdateResponse { webhookEndpoint }

PUT/teams/{teamId}/webhook-endpoints/{webhookEndpointId}

ModelsExpand Collapse

WebhookEndpointCreateResponse { webhookEndpoint }

webhookEndpoint: WebhookEndpoint { id, createdAt, enabled, 9 more }

The creation response, and the only one that carries the secret: it is generated once and never returned again, so a client that loses it has to recreate the endpoint.

id: string

The ID of the webhook endpoint

createdAt: string

The date and time the webhook endpoint was created

enabled: boolean

Whether the webhook is enabled

enabledEvents: Array<"*" | "asset.download.completed" | "asset.download.created" | 16 more>

The events that trigger the webhook. [’*’] indicates that all events are enabled

One of the following:

"*"

"asset.download.completed"

"asset.download.created"

"asset.download.failed"

"generation.completed"

"generation.created"

"generation.failed"

"inference.cancelled"

"inference.completed"

"inference.created"

"inference.failed"

"model.download.completed"

"model.download.created"

"model.download.failed"

"model.training.cancelled"

"model.training.completed"

"model.training.failed"

"model.training.started"

"team.credit.threshold.crossed"

nbFailedCalls: number

The number of calls to the webhook endpoint that have failed

nbTotalCalls: number

The number of calls to the webhook endpoint

ownerId: string

The ID of the owner of the webhook endpoint: a project id for job lifecycle events, a team id for alert events

ownerType: "project" | "team"

Whether the owner is a project or a team. Required to tell them apart: a project created before the team/project split shares its team’s id

One of the following:

"project"

"team"

secret: string

The endpoint’s secret, used to generate webhook signatures

updatedAt: string

The date and time the webhook endpoint was updated

url: string

The URL of the webhook endpoint

description?: string

A description of the webhook endpoint

WebhookEndpointDeleteResponse = unknown

WebhookEndpointListResponse { webhookEndpoints }

webhookEndpoints: Array<WebhookEndpoint>

A list of the team webhooks

id: string

The ID of the webhook endpoint

createdAt: string

The date and time the webhook endpoint was created

enabled: boolean

Whether the webhook is enabled

enabledEvents: Array<"*" | "asset.download.completed" | "asset.download.created" | 16 more>

The events that trigger the webhook. [’*’] indicates that all events are enabled

One of the following:

"*"

"asset.download.completed"

"asset.download.created"

"asset.download.failed"

"generation.completed"

"generation.created"

"generation.failed"

"inference.cancelled"

"inference.completed"

"inference.created"

"inference.failed"

"model.download.completed"

"model.download.created"

"model.download.failed"

"model.training.cancelled"

"model.training.completed"

"model.training.failed"

"model.training.started"

"team.credit.threshold.crossed"

nbFailedCalls: number

The number of calls to the webhook endpoint that have failed

nbTotalCalls: number

The number of calls to the webhook endpoint

ownerId: string

The ID of the owner of the webhook endpoint: a project id for job lifecycle events, a team id for alert events

ownerType: "project" | "team"

Whether the owner is a project or a team. Required to tell them apart: a project created before the team/project split shares its team’s id

One of the following:

"project"

"team"

updatedAt: string

The date and time the webhook endpoint was updated

url: string

The URL of the webhook endpoint

description?: string

A description of the webhook endpoint

WebhookEndpointUpdateResponse { webhookEndpoint }

webhookEndpoint: WebhookEndpoint { id, createdAt, enabled, 8 more }

id: string

The ID of the webhook endpoint

createdAt: string

The date and time the webhook endpoint was created

enabled: boolean

Whether the webhook is enabled

enabledEvents: Array<"*" | "asset.download.completed" | "asset.download.created" | 16 more>

The events that trigger the webhook. [’*’] indicates that all events are enabled

One of the following:

"*"

"asset.download.completed"

"asset.download.created"

"asset.download.failed"

"generation.completed"

"generation.created"

"generation.failed"

"inference.cancelled"

"inference.completed"

"inference.created"

"inference.failed"

"model.download.completed"

"model.download.created"

"model.download.failed"

"model.training.cancelled"

"model.training.completed"

"model.training.failed"

"model.training.started"

"team.credit.threshold.crossed"

nbFailedCalls: number

The number of calls to the webhook endpoint that have failed

nbTotalCalls: number

The number of calls to the webhook endpoint

ownerId: string

The ID of the owner of the webhook endpoint: a project id for job lifecycle events, a team id for alert events

ownerType: "project" | "team"

Whether the owner is a project or a team. Required to tell them apart: a project created before the team/project split shares its team’s id

One of the following:

"project"

"team"

updatedAt: string

The date and time the webhook endpoint was updated

url: string

The URL of the webhook endpoint

description?: string

A description of the webhook endpoint

TeamsWebhook EndpointsEvents

List

client.teams.webhookEndpoints.events.list(, , ?): EventListResponse { items, nextPaginationToken }

GET/teams/{teamId}/webhook-endpoints/{webhookEndpointId}/events

Retrieve

client.teams.webhookEndpoints.events.retrieve(, , ?): EventRetrieveResponse { webhookEvent }

GET/teams/{teamId}/webhook-endpoints/{webhookEndpointId}/events/{eventId}

ModelsExpand Collapse

EventListResponse { items, nextPaginationToken }

items: Array<Item>

A list of the team webhook events

id: string

endpointId: string

status: "created" | "failed" | "retrying" | "success"

One of the following:

"created"

"failed"

"retrying"

"success"

type: "*" | "asset.download.completed" | "asset.download.created" | 16 more

Every event a webhook endpoint can subscribe to: a project endpoint takes the job lifecycle events, a team endpoint takes the alert events.

One of the following:

"*"

"asset.download.completed"

"asset.download.created"

"asset.download.failed"

"generation.completed"

"generation.created"

"generation.failed"

"inference.cancelled"

"inference.completed"

"inference.created"

"inference.failed"

"model.download.completed"

"model.download.created"

"model.download.failed"

"model.training.cancelled"

"model.training.completed"

"model.training.failed"

"model.training.started"

"team.credit.threshold.crossed"

updatedAt: string

nextPaginationToken?: string

A token to query the next page of events

EventRetrieveResponse { webhookEvent }

webhookEvent: WebhookEvent { id, attempts, createdAt, 6 more }

id: string

attempts: Array<Attempt>

responseStatusCode: number

sentAt: string

createdAt: string

endpointId: string

payload: unknown

sentAt: string

status: "created" | "failed" | "retrying" | "success"

One of the following:

"created"

"failed"

"retrying"

"success"

type: "*" | "asset.download.completed" | "asset.download.created" | 16 more

Every event a webhook endpoint can subscribe to: a project endpoint takes the job lifecycle events, a team endpoint takes the alert events.

One of the following:

"*"

"asset.download.completed"

"asset.download.created"

"asset.download.failed"

"generation.completed"

"generation.created"

"generation.failed"

"inference.cancelled"

"inference.completed"

"inference.created"

"inference.failed"

"model.download.completed"

"model.download.created"

"model.download.failed"

"model.training.cancelled"

"model.training.completed"

"model.training.failed"

"model.training.started"

"team.credit.threshold.crossed"

updatedAt: string