Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
transformations

Transform content

Transforms content using a transformation agent in a single API call

This endpoint orchestrates the following operations:

  1. Locates an existing project by external_id, or creates a new one
  2. Creates an input asset from the provided content
  3. Queues a transformation run for processing

Input requirements:

  • article_to_audio, article_to_podcast, and article_to_video agents require asset_type: "article"
  • text_to_audio agents require asset_type: "text"
put/v2/sites/{site_id}/transformation_transform/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Request body

external_idstring required

Unique identifier for the project from your system, such as a CMS article ID

If a project with the same value already exists, a new project will not be created.

transformation_agent_idstring required

Unique identifier for a resource

Example request

{
  "transformation_agent_id": "Ny05CEfj"
}

Response

Transformation run successfully created

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"
    }
  }
}