asset_caption

Analysis

Caption Asset

Generate a caption for a Scenario image asset. Fast, purpose-built captioning. Args: - asset_id: required — the image to caption - details_level: optional — 'action' or 'action+style' - parameters: optional — advanced controls (modelId, seed, temperature, topP, unwantedSequences) - dry_run: optional — true returns a cost estimate without running or charging credits - team_id, project_id: required for OAuth callers Returns: captions (one per image) plus the job record. With dry_run=true, returns a cost estimate. For instruction-driven or interactive analysis (specific questions, custom output format), use asset_analyze (Scenario LLM) instead — it is more flexible than this fixed caption endpoint.
read-onlyidempotentopen-world

Parameters

NameTypeRequiredDescription
asset_idstringScenario asset ID of the image to caption.
details_levelenum(action | action+style)Caption detail: 'action' (subject + action) or 'action+style' (also describes style).
parametersrecordAdvanced caption controls passed through to the API (modelId, seed, temperature, topP, unwantedSequences).
dry_runbooleanEstimate cost without running. Sends ?dryRun=true so the API returns the cost estimate without executing or charging credits.
team_idstringTeam ID. Required if user belongs to multiple teams.
project_idstringProject ID to scope the operation to.
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.

Example Request

JSON
{
  "asset_id": "asset_img001",
  "team_id": "team_abc123",
  "project_id": "proj_xyz789"
}

Example Response

JSON
{
  "source_asset_id": "asset_img001",
  "captions": [
    "A red sports car on a wet city street at night"
  ],
  "detailsLevel": "action"
}

Common Use Cases

  • Auto-caption game assets for searchability and accessibility
  • Generate alt text for a batch of generated images