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

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

const response = await client.assetsImportAsset({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})
{
  "asset": {
    "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>",
      "aspectRatio": "<string>"
    },
    "storagePath": "<string>",
    "thumbnailPath": "<string>",
    "aiTitle": "<string>",
    "aiDescription": "<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>"
  },
  "deduplicated": true
}

Authorizations

Authorization
string
header
required

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

Path Parameters

teamId
string
required

Body

application/json
sourceUrl
string

a string at least 1 character(s) long

Minimum string length: 1
contentBase64
string

a string at least 1 character(s) long

Minimum string length: 1
fileName
string

a string at least 1 character(s) long

Minimum string length: 1
mimeType
string

a string at least 1 character(s) long

Minimum string length: 1
folderId
string<uuid>

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}$

Response

Success

asset
object
required
deduplicated
boolean
required