List status

Reports whether the flow service is reachable and which version it runs.

GET /v1/flow/status

Flow → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/flow/status`
Method	`GET`
Operation	`get_flow_status`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reports whether the flow service is reachable and which version it runs. It is the product's own /health and /v1/version composed — an honest lens for "is the workflow plane up", never a fabricated ok.

Request

GET /v1/flow/status takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	flow.flowStatus	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`reachable`	body	boolean	—	Reachable is true when the flow service answered its health probe.
`version`	body	string	—	Version is the flow service's own version, present only when reachable.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo flow status

.ts

.py

.go

.rs

.java

import { Configuration, FlowApi } from 'hanzoai';

const api = new FlowApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFlowStatus();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FlowApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FlowApi(client).get_flow_status()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FlowAPI.GetFlowStatus(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, flow_api};

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

let result = flow_api::get_flow_status(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FlowApi;

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

var result = new FlowApi(client).getFlowStatus();

curl https://api.hanzo.ai/v1/flow/status \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool flow, op get_flow_status — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

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

Flow API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList runs NextGet workflows