PATCH
/
v1
/
teams
/
{teamId}
/
assets
/
{assetId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.assets.updateAssetMetadata({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  assetId: process.env.OCTOSPARK_ASSET_ID ?? "assetId",
  body: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalFilename": "<string>",
  "fileSize": 123,
  "mimeType": "<string>",
  "assetTypeData": {
    "type": "image",
    "width": 123,
    "height": 123,
    "format": "<string>",
    "colorSpace": "<string>",
    "meme": {
      "sourceTemplateId": "<string>",
      "sourceUrl": "<string>",
      "captionBoxCount": 1,
      "templatePageUrl": "<string>",
      "captionZones": [
        {
          "key": "<string>",
          "label": "<string>",
          "x": 0.5,
          "y": 0.5,
          "width": 0,
          "height": 0,
          "style": {
            "fontFamily": "<string>",
            "fontSize": 259,
            "fill": "<string>",
            "stroke": "<string>",
            "strokeWidth": 10,
            "bold": true,
            "uppercase": true,
            "italic": true,
            "shadow": true,
            "opacity": 0.5
          },
          "rotation": 0
        }
      ],
      "layout": {
        "sourcePageUrl": "<string>",
        "capturedAt": "<string>",
        "canvasWidth": 4096.5,
        "canvasHeight": 4096.5,
        "imageBounds": {
          "x": 0.5,
          "y": 0.5,
          "width": 0,
          "height": 0
        },
        "sourceApiUrl": "<string>",
        "generatorScriptUrl": "<string>",
        "modelId": "<string>",
        "generationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    },
    "aspectRatio": "<string>"
  },
  "storagePath": "<string>",
  "thumbnailPath": "<string>",
  "aiTitle": "<string>",
  "aiDescription": "<string>",
  "aiAltText": "<string>",
  "aiTags": [
    "<string>"
  ],
  "contentHash": "<string>",
  "processingError": "<string>",
  "isDeleted": true,
  "deletedAt": "<string>",
  "hardDeletedAt": "<string>",
  "sharedWithOrg": true,
  "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "folderName": "<string>",
  "displayName": "<string>",
  "aspectRatio": "<string>",
  "isProcessing": true,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

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.

​
assetId
string
required

Media-library asset id (UUID), as returned by asset list, search, and upload endpoints.

Body

application/json
​
aiTitle
string | null

Asset title shown in the media library; omit to keep the current title or send null to clear it.

​
aiDescription
string | null

Description of the asset content; omit to keep the current description or send null to clear it.

​
aiAltText
string | null

Accessibility alt text for visual media, max 1000 characters; null clears it. Propagated to social providers that support per-image alt text.

Maximum string length: 1000
​
aiTags
string[]

Replace the asset tags with this list; omit to keep existing tags or send an empty array to clear them.

​
sharedWithOrg
boolean

Whether other teams in the organisation can use this asset; omit to keep its current sharing setting.

Response

Success

​
id
string<uuid>
required

a Universally Unique Identifier

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}$
​
teamId
string<uuid>
required

a Universally Unique Identifier

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}$
​
originalFilename
string
required
​
fileSize
number
required
​
mimeType
string
required
​
assetType
enum<string>
required
Available options:
image,
video,
audio,
gif,
document
​
assetCategory
enum<string>
required
Available options:
user_upload,
render,
template,
green_screen_template,
sound_effect,
music,
brand_asset,
ai_image,
ai_video,
other
​
assetTypeData
object
required
​
storagePath
string
required
​
thumbnailPath
string | null
required
​
aiTitle
string | null
required
​
aiDescription
string | null
required
​
aiAltText
string | null
required
​
aiTags
string[]
required
​
contentHash
string | null
required
​
processingStatus
enum<string>
required
Available options:
pending,
processing,
completed,
failed
​
processingError
string | null
required
​
isDeleted
boolean
required
​
deletedAt
string | null
required
​
hardDeletedAt
string | null
required
​
sharedWithOrg
boolean
required
​
folderId
string<uuid> | null
required

a Universally Unique Identifier

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}$
​
folderName
string | null
required
​
displayName
string
required
​
aspectRatio
string | null
required
​
isProcessing
boolean
required
​
createdAt
string
required
​
updatedAt
string
required