> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sia.vision/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an Artifact design reference

> artifact_image_generate: permissions and generated input/output contracts.

`artifact_image_generate` · Gateway release **0.8.3**

Use the existing Studio image provider and account billing to create one review candidate. Use saved sources by default, selected references for refinement, or explicit text-only mode. Optional Character and Production context are frozen; navigation cannot retarget the result. All intended inputs must fit the four-image budget; none are dropped. Poll/recover the original job after uncertainty. Never automatically submit a paid replacement.

Required scopes: `account:read`, `studio:generate`. Changes saved state or requests work; review the operation’s effects.

Availability depends on runtime configuration and the permissions granted to this connection. Use live MCP discovery as the authority.

## Input

```json theme={null}
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "storyworldId": {
      "type": "string",
      "pattern": "^[a-fA-F0-9]{24}$",
      "description": "ID of an accessible saved Storyworld returned by discovery. Keep this destination fixed for the operation."
    },
    "artifactId": {
      "type": "string",
      "pattern": "^[a-fA-F0-9]{24}$",
      "description": "ID of the reusable prop, clothing or accessory, distinct from its Media image IDs."
    },
    "expectedVersion": {
      "type": "integer",
      "minimum": 1,
      "description": "Copy the current version from the latest workflow read. Refresh after a conflict; never increment or guess it."
    },
    "operationId": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9-]{16,64}$",
      "description": "Persist a client-generated UUID before this mutation. Repeat identical inputs and this same ID after interruption; a new ID is a new request."
    },
    "sourceMode": {
      "enum": [
        "sources",
        "selected",
        "text"
      ],
      "description": "Use saved sources by default, selected references for refinement, or text only when explicitly intended."
    },
    "characterId": {
      "type": "string",
      "pattern": "^[a-fA-F0-9]{24}$",
      "description": "ID of the exact saved Character to reuse; do not create a new identity for an outfit or accessory."
    },
    "direction": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    },
    "aspect": {
      "enum": [
        "1:1",
        "16:9",
        "9:16"
      ]
    },
    "production": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "productionId": {
          "type": "string",
          "pattern": "^[a-fA-F0-9]{24}$",
          "description": "ID of the saved Production whose asset context must remain pinned."
        },
        "expectedVersion": {
          "type": "integer",
          "minimum": 1,
          "description": "Copy the current version from the latest workflow read. Refresh after a conflict; never increment or guess it."
        },
        "bindingId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "shotId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Exact originating shot ID; navigation must not retarget an admitted generation."
        }
      },
      "required": [
        "productionId",
        "expectedVersion"
      ],
      "description": "Optional originating Production context to freeze. Does not implicitly attach the result to a shot."
    }
  },
  "required": [
    "storyworldId",
    "artifactId",
    "expectedVersion",
    "operationId"
  ]
}
```

## Declared output

This is the declared success schema. Error results and binary media blocks are separate MCP protocol results.

```json theme={null}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "jobId": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    },
    "status": {
      "type": "string"
    }
  },
  "required": [
    "schemaVersion",
    "jobId",
    "status"
  ],
  "additionalProperties": {}
}
```

[All tools](https://docs.sia.vision/mcp-reference.md) · [Permissions](https://docs.sia.vision/authentication.md) · [Media and recovery](https://docs.sia.vision/media-and-recovery.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.