GET
/
v1
/
teams
/
{teamId}
/
ai-media
/
models
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.aiMedia.listModels({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {},
})
{
  "data": [
    {
      "id": "<string>",
      "label": "<string>",
      "providerModelId": "<string>",
      "capabilitySchemaVersion": "<string>",
      "capabilities": {
        "modality": "image",
        "aspectRatios": [],
        "counts": {
          "min": 123,
          "max": 123
        },
        "referenceImages": {
          "max": 123
        },
        "allowedPassthroughParameters": [
          "<string>"
        ],
        "uiSchemaId": "<string>",
        "resolutions": [],
        "qualities": [],
        "sizes": [
          "<string>"
        ],
        "seed": {
          "supported": true,
          "default": true
        },
        "negativePrompt": {
          "supported": true,
          "default": true
        }
      },
      "defaultParams": {},
      "enabled": true,
      "description": "<string>",
      "isNew": true,
      "providerEndpointId": "<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

modality
enum<string>

Return only models for this modality (image or video).

Available options:
image,
video
provider
enum<string>

Return only models from this provider (for example the code for OpenAI, Google, or fal.ai).

Available options:
google,
openai,
bytedance,
kuaishou,
alibaba,
openrouter,
fal
route
enum<string>

Return only models reachable over this route (for example openrouter or a direct provider route).

Available options:
openrouter,
fal

Response

Success

data
object[]
required