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

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

const response = await client.assets.searchAssets({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {
    "query": process.env.OCTOSPARK_QUERY ?? "query",
  },
})
{
  "data": [
    {
      "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>"
    }
  ],
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<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.

Query Parameters

query
string
required

Keyword search query matched against asset names, tags, and AI-derived metadata.

Minimum string length: 1
Example:

"product launch banner"

semantic
string

Reserved for a future semantic mode: any truthy value currently returns 400 (semantic search via this endpoint is not yet available). Omit it, and use searchAgenticAssets for natural-language search.

Example:

"false"

cursor
string

Opaque pagination cursor from the previous page response (nextCursor/prevCursor); omit to start at the first page.

limit
string
default:25

Page size as a positive integer string; defaults to 25, capped at 100.

Examples:

"25"

"100"

sortBy
string

Field to sort by; each endpoint accepts its own allowlist and defaults to createdAt.

Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort direction: asc or desc; defaults to desc.

Available options:
asc,
desc
filter[assetType]
enum<string>

Restrict results to one media type (e.g. image or video).

Available options:
image,
video,
audio,
gif,
document

Response

Success

data
object[]
required
total
number
required
nextCursor
string | null
required
prevCursor
string | null
required