POST
/
v1
/
teams
/
{teamId}
/
ai-media
/
logo-overlays
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.aiMedia.overlayBrandLogo({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})
{
  "assetId": "<string>",
  "sourceAssetId": "<string>",
  "brandId": "<string>",
  "logoAssetId": "<string>",
  "width": 123,
  "height": 123,
  "logo": {
    "left": 123,
    "top": 123,
    "width": 123,
    "height": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Body

application/json
assetId
string<uuid>
required

The team image to brand, e.g. a generated pin. It is not modified.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
brandId
string<uuid>

Brand whose logoAssetId to use; defaults to the team's primary brand.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
placement
object

Logo position and size. Omit to place it bottom-right at 18% width with 4% padding.

Response

Success

assetId
string
required

The new branded image asset.

sourceAssetId
string
required
brandId
string
required
logoAssetId
string
required
width
number
required
height
number
required

Where the logo was placed, in pixels of the output image.