List events

Holds text/event-stream open on one run you may read and writes one frame per change until the run ends, then a final done frame, and closes.

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

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

Holds text/event-stream open on one run you may read and writes one frame per change until the run ends, then a final done frame, and closes. Every frame carries id:, the event's sequence number in the run, so a client that reconnects with Last-Event-ID (or ?after=) receives exactly what it missed. A run that already ended replays its events and closes.

Frames (event: name, data: JSON): run {seq, run} on a status change; step {seq, run, step} when a step's status, attempt or progress moves; asset {seq, run, step, asset} when an output lands, as its Library item with fresh signed URLs; log {seq, run, step, text}; done {seq, run} when the run ended (succeeded, failed or canceled). Each carries the run, step or asset as it is now. A : ping comment every 15 seconds keeps intermediaries from closing the stream.

Authenticate with Authorization: Bearer (a fetch-based reader; a browser EventSource cannot set it) or the session cookie. 404 for a run you may not read; 429 when your org already holds 64 streams.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyes

Response

StatusBodyMeaning
2XXstringSuccess

2XX body — 1 field.

FieldInTypeAlwaysDescription
(body)bodystring (binary)yes

Failure carries the platform error shape — see Errors.

Examples

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

const api = new StudioApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getStudioRunsByIdEvents({ 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_events(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.StudioAPI.GetStudioRunsByIdEvents(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_events(&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).getStudioRunsByIdEvents();
curl https://api.hanzo.ai/v1/studio/runs/<id>/events \
  -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.