OpenapiFlow
Workflow reads one of the caller's workflows — the full record, graph included.
Workflow reads one of the caller's workflows — the full record, graph included.
GET /v1/flow/workflows/{workflow}
| Address | https://api.hanzo.ai/v1/flow/workflows/{workflow} |
| Method | GET |
| Operation | get_flow_workflows_by_workflow |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Workflow reads one of the caller's workflows — the full record, graph included. A workflow outside the caller's org answers 404, indistinguishable from one that does not exist.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
workflow | path | string | yes | Workflow is the workflow's UUID, taken from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
(body) | body | any | yes |
Failure carries the platform error shape — see Errors.
Examples
hanzo flow workflows get <workflow>import { Configuration, FlowApi } from 'hanzoai';
const api = new FlowApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFlowWorkflowsByWorkflow({ workflow: 'workflow' });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_workflows_by_workflow(workflow='workflow')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FlowAPI.GetFlowWorkflowsByWorkflow(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_workflows_by_workflow(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FlowApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new FlowApi(client).getFlowWorkflowsByWorkflow();curl https://api.hanzo.ai/v1/flow/workflows/<workflow> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches flow through the flow tool, which names its 8 operations with its own verbs — this one among them, under a name only the door 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_flow_runs"
}
}
}'How is this guide?