Scenarios

Get scenario by ID

Changed on

Returns the scenario details and full blueprint for the given scenario.

get/api/v3/scenarios/{scenarioId}

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/scenarios/{scenarioId}
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Path parameters

scenarioIdnumber required
Example:123

Scenario ID

Query parameters

fieldsstring
Example:id,name

Comma-separated list of fields to include in the response.

Allowed fields:

  • id
  • name
  • teamId
  • description
  • folderId
  • usedPackages
  • isInvalid
  • isActive
  • isLocked
  • isPaused
  • isWaiting
  • sequential
  • lastEdit
  • scheduling
  • hookId
  • deleted
  • deletedBy
  • blueprint

Response

Scenario details and blueprint

idnumber required

Unique scenario identifier within the organization context.

namestring required

Display name of the scenario.

teamIdnumber required

ID of the team that owns this scenario (maps to the team/company in Fusion).

descriptionstring

Optional longer description shown in the UI.

folderIdnumber

Folder ID for organizing scenarios; omit if the scenario is not in a folder.

usedPackagesstring[]

Identifiers of app packages or modules referenced by the scenario (for example integrations).

isInvalidboolean required

True when the scenario is considered invalid (for example disabled after repeated errors).

isActiveboolean required

Whether the scenario is linked and eligible to run.

isLockedboolean required

True while the scenario cannot be executed (for example still being configured).

isPausedboolean required

True when execution is paused after errors until the scenario is resumed.

sequentialboolean required

Whether modules in the scenario run strictly in order (sequential execution).

lastEditstring date-time

ISO 8601 timestamp of the last modification to the scenario.

schedulingobject

Schedule definition when the scenario is triggered on a timer (shape depends on scheduler settings).

hookIdnumber

Webhook device ID if the scenario is driven by an incoming hook; omit if not hook-based.

deletedboolean

True when the scenario has been soft-deleted (moved to the recycle bin). Defaults to false in the response when the row is active. Clients can filter on deleted==true to list bin contents.

deletedBynumber nullable

ID of the user who moved this scenario to the recycle bin. Null for active scenarios and for deleted scenarios predating the audit column or created by system-driven deletes.

blueprintobject required

Full automation blueprint: modules, flow, parameters, and metadata. Structure depends on the apps and modules in use.

Example response

{
  "id": 123,
  "name": "Daily data sync",
  "teamId": 88,
  "description": "Generate an image.",
  "folderId": 10,
  "usedPackages": [
    "adobe-firefly"
  ],
  "sequential": true,
  "lastEdit": "2026-03-05T15:20:00.000Z",
  "scheduling": {
    "time": "07:53",
    "type": "daily"
  },
  "hookId": 555,
  "blueprint": {
    "flow": [
      {
        "id": 1,
        "mapper": {
          "n": "1",
          "style": {
            "imageReference": {}
          },
          "locale": "en-US",
          "prompt": "ocean and pineapple cocktail",
          "extension": "default",
          "structure": {
            "imageReference": {}
          }
        },
        "module": "adobe-firefly:generateAnImage2",
        "version": 1,
        "metadata": {
          "expect": [
            {
              "name": "prompt",
              "type": "text",
              "label": "Prompt",
              "required": true
            },
            {
              "name": "modelVersion",
              "type": "select",
              "label": "Model version",
              "validate": {
                "enum": [
                  "image3",
                  "image3_custom",
                  "image4_standard",
                  "image4_ultra",
                  "image4_custom"
                ]
              }
            },
            {
              "name": "n",
              "type": "number",
              "label": "Number of variations"
            },
            {
              "name": "extension",
              "type": "select",
              "label": "Generated image format",
              "required": true,
              "validate": {
                "enum": [
                  "jpeg",
                  "png",
                  "webp",
                  "default"
                ]
              }
            },
            {
              "name": "negativePrompt",
              "type": "text",
              "label": "Negative prompt"
            },
            {
              "name": "contentClass",
              "type": "select",
              "label": "Content class",
              "validate": {
                "enum": [
                  "photo",
                  "art"
                ]
              }
            },
            {
              "name": "seeds",
              "type": "array",
              "label": "Seeds"
            },
            {
              "name": "size",
              "type": "select",
              "label": "Size",
              "validate": {
                "enum": [
                  "2048,2048",
                  "1024,1024",
                  "2304,1792",
                  "1792,2304",
                  "2688,1536",
                  "1344,768",
                  "1152,896",
                  "896,1152"
                ]
              }
            },
            {
              "name": "visualIntensity",
              "type": "number",
              "label": "Visual intensity"
            },
            {
              "name": "locale",
              "type": "text",
              "label": "Locale"
            },
            {
              "name": "tileable",
              "type": "boolean",
              "label": "Tileable"
            },
            {
              "name": "structure",
              "spec": [
                {
                  "name": "imageReference",
                  "spec": [
                    {
                      "name": "source",
                      "type": "select",
                      "label": "Source",
                      "validate": {
                        "enum": [
                          "file",
                          "presignedUrl"
                        ]
                      }
                    },
                    {
                      "name": "strength",
                      "type": "number",
                      "label": "Strength"
                    }
                  ],
                  "type": "collection",
                  "label": "Image reference"
                }
              ],
              "type": "collection",
              "label": "Structure"
            },
            {
              "name": "style",
              "spec": [
                {
                  "name": "imageReference",
                  "spec": [
                    {
                      "name": "source",
                      "type": "select",
                      "label": "Source",
                      "validate": {
                        "enum": [
                          "file",
                          "presignedUrl"
                        ]
                      }
                    },
                    {
                      "name": "strength",
                      "type": "number",
                      "label": "Strength"
                    },
                    {
                      "name": "presets",
                      "type": "array",
                      "label": "Presets"
                    }
                  ],
                  "type": "collection",
                  "label": "Image reference"
                }
              ],
              "type": "collection",
              "label": "Style"
            }
          ],
          "restore": {
            "size": {
              "mode": "chose",
              "label": ""
            },
            "seeds": {
              "mode": "chose",
              "items": []
            },
            "style": {
              "nested": {
                "imageReference": {
                  "nested": {
                    "source": {
                      "mode": "chose",
                      "label": ""
                    },
                    "presets": {
                      "mode": "chose",
                      "items": []
                    }
                  }
                }
              }
            },
            "tileable": {
              "mode": "chose"
            },
            "extension": {
              "mode": "chose",
              "label": "Default"
            },
            "structure": {
              "nested": {
                "imageReference": {
                  "nested": {
                    "source": {
                      "mode": "chose",
                      "label": ""
                    }
                  }
                }
              }
            },
            "connection": {
              "label": "My Adobe Firefly Connection connection"
            },
            "contentClass": {
              "mode": "chose",
              "label": ""
            },
            "modelVersion": {
              "mode": "chose",
              "label": ""
            }
          },
          "designer": {
            "x": 0,
            "y": 0
          },
          "parameters": [
            {
              "name": "connection",
              "type": "account",
              "label": "Connection",
              "required": true
            }
          ]
        },
        "parameters": {
          "connection": 23252
        }
      }
    ],
    "name": "Integration Adobe Firefly",
    "metadata": {
      "instant": false,
      "version": 1,
      "designer": {
        "orphans": []
      },
      "scenario": {
        "dlq": false,
        "dataloss": false,
        "maxErrors": 3,
        "autoCommit": true,
        "roundtrips": 1,
        "sequential": false,
        "confidential": false,
        "autoCommitTriggerLast": true
      }
    }
  }
}

Changes

  • 9eea20e77721Revision changes
    • info

      added the new optional query request parameter fields

  • 7c7767c7a45fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status