Replace capture

Turns capture on or off for the org's Kai decisions from the next one.

PUT /v1/capabilities/capture

Addresshttps://api.hanzo.ai/v1/capabilities/capture
MethodPUT
OperationcapabilitiesSetCapture
AuthAuthorization: Bearer $HANZO_API_KEY

Turns capture on or off for the org's Kai decisions from the next one. Off keeps what was captured until its retention ends.

Request

1 field, body application/json (required).

FieldInTypeRequiredDescription
onbodyboolean—

Response

StatusBodyMeaning
200train.Captureok
defaultproblem-detailsrefused

200 body — 2 fields.

FieldInTypeAlwaysDescription
onbodyboolean—
retention_daysbodyinteger (int64)—RetentionDays is how long a decision's states are kept unless a correction names it.

Failure carries the platform error shape — see Errors.

Examples

hanzo capabilities capture replace
import { Configuration, TrainApi } from 'hanzoai';

const api = new TrainApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.capabilitiesSetCapture({ on: false });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TrainApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TrainApi(client).capabilities_set_capture(on=False)
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

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

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

let result = train_api::capabilities_set_capture(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TrainApi;

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

var result = new TrainApi(client).capabilitiesSetCapture();
curl -X PUT https://api.hanzo.ai/v1/capabilities/capture \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "on": false
     }'

Tool train, op capabilitiesSetCapture — 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": "train",
         "arguments": {
           "op": "capabilitiesSetCapture",
           "input": {
             "on": false
           }
         }
       }
     }'

Train 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.