Hanzo Docs
Sign inAPI key

List versions

Lists every version of a creation you may read — the runs in this run's lineage — oldest (version 1) first.

GET /v1/studio/runs/{id}/versions

Studio → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/studio/runs/{id}/versions
MethodGET
Operationget_studio_runs_by_id_versions
AuthAuthorization: Bearer $HANZO_API_KEY

Lists every version of a creation you may read — the runs in this run's lineage — oldest (version 1) first.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the resource's id, from the path.

Response

StatusBodyMeaning
200studio.RunPageok
defaultproblem-detailsrefused

200 body — 79 fields.

FieldInTypeAlwaysDescription
databodystudio.Run[]—
data[].brandbodystring—
data[].charged_centsbodyinteger (int64)—ChargedCents is what the finished steps cost; final once the run ends.
data[].createdbodystring—
data[].creatorbodystring—
data[].errorbodystudio.Problem—
data[].error.codebodystring—
data[].error.detailbodystring—
data[].error.statusbodyinteger (int64)—
data[].error.titlebodystring—
data[].error.typebodystring—
data[].estimate_centsbodyinteger (int64)—EstimateCents is what was reserved when the run started.
data[].finishedbodystring—
data[].flowbodystring—
data[].graphbodystudio.Graph—
data[].graph.stepsbodystudio.Spec[]—Steps are the graph's steps, 1 to 64 of them.
data[].graph.steps[].eachbodystring—Each fans the step out: a {{path}} naming an array, run once per item (at most 64), its outputs the items' outputs in order.
data[].graph.steps[].idbodystring—ID names the step within its graph: a lowercase letter, then up to 31 lowercase letters, digits or underscores.
data[].graph.steps[].opbodystring—Op is what the step does: chat, image.generate, image.edit, voice.speak, music.generate, video.generate, model.generate, studio.render, render.html, render.document, render.slides, render.composition or video.edit.
data[].graph.steps[].titlebodystring—Title is what a person sees for the step.
data[].graph.steps[].withbodyobject—With are the op's parameters.
data[].graph.steps[].with.*bodyany—
data[].idbodystring—
data[].inputbodyobject—Input is what the run was given, as its inputs schema reads it.
data[].input.*bodyany—
data[].kindbodystring—
data[].orgbodystring—
data[].outputsbodystudio.Item[]—Outputs are the Library items the run made, the final steps' first.
data[].outputs[].bytesbodyinteger (int64)—
data[].outputs[].createdbodystring—
data[].outputs[].downloadbodystring—
data[].outputs[].expiresbodystring—
data[].outputs[].heightbodyinteger (int64)—
data[].outputs[].idbodystring—
data[].outputs[].kindbodystring—
data[].outputs[].mimebodystring—
data[].outputs[].minebodyboolean—
data[].outputs[].namebodystring—
data[].outputs[].originbodystring—
data[].outputs[].ownerbodystring—
data[].outputs[].pagesbodyinteger (int64)—
data[].outputs[].previewbodystring—
data[].outputs[].refbodystring—
data[].outputs[].secondsbodynumber (double)—
data[].outputs[].sharedbodyboolean—
data[].outputs[].sourcebodystring—
data[].outputs[].urlbodystring—URL opens the file inline; Download saves it; Preview is its still.
data[].outputs[].widthbodyinteger (int64)—
data[].parentbodystring—
data[].rootbodystring—Root is the first version's id; equal to id on version 1.
data[].sharedbodyboolean—
data[].startedbodystring—
data[].statusbodystring—
data[].stepsbodystudio.Step[]—
data[].steps[].attemptbodyinteger (int64)—Attempt is how many times the step has started.
data[].steps[].cost_centsbodyinteger (int64)—
data[].steps[].errorbodystudio.Problem—
data[].steps[].error.codebodystring—
data[].steps[].error.detailbodystring—
data[].steps[].error.statusbodyinteger (int64)—
data[].steps[].error.titlebodystring—
data[].steps[].error.typebodystring—
data[].steps[].executorbodystring—Executor is where the step runs: gateway, studio.render, render or flow.run.
data[].steps[].finishedbodystring—
data[].steps[].idbodystring—
data[].steps[].itemsbodyinteger (int64)—Items is how many items a step with each fanned out to.
data[].steps[].messagebodystring—Message is what the step is doing now, for a person.
data[].steps[].opbodystring—
data[].steps[].outputsbodystring[]—Outputs are the Library item ids the step made.
data[].steps[].progressbodynumber (double)—
data[].steps[].startedbodystring—
data[].steps[].statusbodystring—Status is pending, queued, running, succeeded, failed, canceled or skipped.
data[].steps[].textbodystring—
data[].steps[].titlebodystring—
data[].templatebodystring—
data[].textbodystring—Text is the last chat step's text, when the run's product is words.
data[].titlebodystring—
data[].versionbodyinteger (int64)—
nextbodystring—

Failure carries the platform error shape — see Errors.

Examples

hanzo studio runs versions <id>
import { Configuration, StudioApi } from 'hanzoai';

const api = new StudioApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getStudioRunsByIdVersions({ id: 'id' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import StudioApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = StudioApi(client).get_studio_runs_by_id_versions(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.StudioAPI.GetStudioRunsByIdVersions(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, studio_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = studio_api::get_studio_runs_by_id_versions(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.StudioApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new StudioApi(client).getStudioRunsByIdVersions();
curl https://api.hanzo.ai/v1/studio/runs/<id>/versions \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches studio through the studio tool, which names its 32 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_studio_brands"
         }
       }
     }'

Studio API · All Hanzo APIs · Interactive reference

Was this page useful?
Broken link or missing step? Drop it in #docs on Discord or open a PR.
PreviousList eventsNextGet runs