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

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

const response = await client.aiMedia.getModel({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {
    "modelId": process.env.OCTOSPARK_MODEL_ID ?? "modelId",
  },
})
{
  "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

modelId
string
required

Catalog model id to fetch, e.g. "google/veo-3.1-fast". Carried as a query parameter because catalog ids contain a slash.

Response

Success

id
string
required
label
string
required
modality
enum<string>
required
Available options:
image,
video
route
enum<string>
required
Available options:
openrouter,
fal
routingProviderCode
enum<string>
required
Available options:
google,
openai,
bytedance,
kuaishou,
alibaba,
openrouter,
fal
modelOwnerProviderCode
enum<string>
required
Available options:
google,
openai,
bytedance,
kuaishou,
alibaba,
openrouter,
fal
providerModelId
string
required
capabilitySchemaVersion
string
required
capabilities
object
required
defaultParams
object
required
pricingSource
enum<string>
required
Available options:
openrouter_usage,
provider_snapshot
enabled
boolean
required
description
string
isNew
boolean
providerEndpointId
string