Delete reference

Removes one of your organisation's overrides.

DELETE /v1/reference/{set}

Addresshttps://api.hanzo.ai/v1/reference/{set}
MethodDELETE
OperationriskClearReference
AuthAuthorization: Bearer $HANZO_API_KEY

Removes one of your organisation's overrides.

It removes an entry your organisation wrote, never a baseline member: the published set is not writable from here, so a removal can only ever restore the baseline's own answer.

Request

2 fields.

FieldInTypeRequiredDescription
setpathstringyes
keyquerystring—

Response

StatusBodyMeaning
200reference.ClearReferenceOutok
defaultproblem-detailsrefused

200 body — 4 fields.

FieldInTypeAlwaysDescription
clearedbodyboolean—Cleared is false when your org held no such override — which is not an error, it is the honest answer to a removal that had nothing to remove.
keybodystring—Key is the entry named.
overridesbodyinteger (int64)—Overrides is how many your org still holds in this set.
setbodystring—Set is the set cleared in.

Failure carries the platform error shape — see Errors.

Examples

hanzo reference rm <set>
import { Configuration, ReferenceApi } from 'hanzoai';

const api = new ReferenceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.riskClearReference({ set: 'set' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ReferenceApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ReferenceApi(client).risk_clear_reference(set='set')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

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

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

let result = reference_api::risk_clear_reference(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ReferenceApi;

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

var result = new ReferenceApi(client).riskClearReference();
curl -X DELETE https://api.hanzo.ai/v1/reference/<set> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool reference, op riskClearReference — 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": "reference",
         "arguments": {
           "op": "riskClearReference",
           "input": {
             "set": "<set>"
           }
         }
       }
     }'

Reference API · All Hanzo APIs · Interactive reference

Was this page useful?