Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
transformations

Decide on a transformation run step

Records a reviewer's decision on a step that is awaiting_approval and applies the corresponding status changes to the step's draft input assets

  • approve: The step succeeds and the run resumes. Asset versions listed in approved_asset_version_ids move to ready. Other draft inputs remain in draft.
  • reject: The step and run fail. All draft inputs move to disabled.
  • regenerate: The step succeeds and the run resumes with a fresh attempt. All draft inputs move to disabled. Use additional_context to guide the regeneration. Asset versions listed in regenerate_input_asset_version_ids are used as inputs for the new attempt. If none are provided, the predecessor step's inputs are reused.
put/v2/sites/{site_id}/transformation_run_steps/{transformation_run_step_id}/decide/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

transformation_run_step_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of a single step within a transformation run

Request body

decision'approve' | 'reject' | 'regenerate' required

Reviewer decision recorded on a human-in-the-loop review step

decided_bystring

Unique identifier for a resource

approved_asset_version_idsResourceId[]

Asset version IDs to approve

Used with the approve decision; the listed draft versions move to ready.

regenerate_input_asset_version_idsResourceId[]

Asset version IDs to use as the regenerated step's input

Use this with the regenerate decision. Listed versions become the regenerated step's input.

Example request

{
  "decided_by": "Ny05CEfj",
  "approved_asset_version_ids": [
    "Ny05CEfj"
  ],
  "regenerate_input_asset_version_ids": [
    "Ny05CEfj"
  ],
  "additional_context": {
    "asset_version_ids": [
      "Ny05CEfj"
    ]
  }
}

Response

Step decision applied successfully

idstring

Unique identifier for a resource

site_idstring

Unique identifier for a resource

type'transformation_run_step'

Resource type identifier

transformation_run_idstring

Unique identifier for a resource

step_typestring

Type of work performed by this step, such as script generation, audio generation, or review

started_atstring date-time nullable

Timestamp when the step started processing

Example response

{
  "id": "Ny05CEfj",
  "site_id": "Ny05CEfj",
  "transformation_run_id": "Ny05CEfj",
  "lineage": {
    "parent_step_ids": [
      "Ny05CEfj"
    ],
    "retried_from_step_id": "Ny05CEfj"
  },
  "metadata": {
    "output_data": {
      "asset_version_ids": [
        "Ny05CEfj"
      ],
      "decision": {
        "decided_by": "Ny05CEfj",
        "approved_asset_version_ids": [
          "Ny05CEfj"
        ],
        "regenerate_input_asset_version_ids": [
          "Ny05CEfj"
        ]
      }
    }
  },
  "relationships": {
    "transformation_run": {
      "id": "Ny05CEfj"
    }
  }
}