v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

transformations

Get a transformation run

Retrieves a specific transformation run by ID

get/v2/sites/{site_id}/transformation_runs/{transformation_run_id}/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

transformation_run_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of a single execution (run) of a transformation

Response

Transformation run successfully retrieved

idstring

Unique identifier for a resource

site_idstring

Unique identifier for a resource

type'transformation_run'

Resource type identifier

createdstring date-time

Timestamp when the run was created

transformation_type'article_to_audio' | 'article_to_podcast' | 'article_to_video' | 'text_to_audio'

Type of content transformation

state'queued' | 'running' | 'awaiting_approval' | 'failed' | 'succeeded'

Processing state of the transformation run

queued: Run is waiting to be picked up for processing
running: Run is actively being processed
awaiting_approval: Run is paused on a human-in-the-loop review step
failed: Run encountered an error and did not complete
succeeded: Run completed successfully

output_asset_version_idsResourceId[]

IDs of the output asset versions produced by this transformation

transformation_configobject

Configuration snapshot used for this run

started_atstring date-time

Timestamp when processing started

ended_atstring date-time

Timestamp when processing completed

metadataobject

No mutable fields for transformation runs

Example response

{
  "id": "Ny05CEfj",
  "site_id": "Ny05CEfj",
  "run_inputs": {
    "input_asset_version_ids": [
      "Ny05CEfj"
    ],
    "step_inputs": [
      {
        "input_asset_version_ids": [
          "Ny05CEfj"
        ]
      }
    ]
  },
  "output_asset_version_ids": [
    "Ny05CEfj"
  ],
  "relationships": {
    "project": {
      "id": "Ny05CEfj"
    },
    "transformation_agent": {
      "id": "Ny05CEfj"
    }
  }
}