List actions

Returns the caller org's Business AI action ledger, most recent first: every "do it for me" tool call, the arguments it ran with, its result and whether it succeeded.

GET /v1/guide/actions

Guide → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/guide/actions`
Method	`GET`
Operation	`get_guide_actions`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the caller org's Business AI action ledger, most recent first: every "do it for me" tool call, the arguments it ran with, its result and whether it succeeded. It is the audit-visible record of what the agent did on the org's behalf, and the backing state for the "acted" auto-detect signal.

Request

GET /v1/guide/actions takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	guide.actionsView	ok
`default`	problem-details	refused

200 body — 9 fields.

Field	In	Type	Always	Description
`data`	body	guide.ActionRecord[]	—	Data is the most-recent actions first, capped at listActionsLimit.
`data[].args`	body	string	—	Args is the JSON the tool was called with, recorded as TEXT exactly as sent — including whatever the AI drafted into it — so a run can be read back and reproduced.
`data[].createdAt`	body	integer (int64)	—	CreatedAt is when the run was recorded, as Unix seconds.
`data[].err`	body	string	—	Err is why the run failed, when it did.
`data[].id`	body	string	—	ID identifies this one execution.
`data[].ok`	body	boolean	—	OK is whether the tool ran to completion.
`data[].result`	body	string	—	Result is the tool's own answer, likewise recorded as JSON text.
`data[].stepId`	body	string	—	StepID is the checklist step the Business AI was acting on.
`data[].tool`	body	string	—	Tool is the MCP tool that was dispatched, by name.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo guide actions

.ts

.py

.go

.rs

.java

import { Configuration, GuideApi } from 'hanzoai';

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

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = GuideApi(client).get_guide_actions()

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

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

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

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

let result = guide_api::get_guide_actions(&cfg, Default::default()).await?;

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

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

var result = new GuideApi(client).getGuideActions();

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

MCP reaches guide through the guide tool, which names its 13 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_guides"
         }
       }
     }'

Guide API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousDelete curriculum NextList analytics