Delete curriculum

Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.

DELETE /v1/guide/curriculum

Addresshttps://api.hanzo.ai/v1/guide/curriculum
MethodDELETE
Operationdelete_guide_curriculum
AuthAuthorization: Bearer $HANZO_API_KEY

Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture. Clearing an org that never set one is a no-op that answers the same default.

Request

DELETE /v1/guide/curriculum takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200guide.curriculumViewok
defaultproblem-detailsrefused

200 body — 17 fields.

FieldInTypeAlwaysDescription
curriculumbodyguide.Curriculum—
curriculum.stepsbodyguide.JourneyStep[]—Steps are the enabled steps in authoring order.
curriculum.steps[].argsbodyobject—Args are the tool's default arguments, merged under whatever the caller passes at run time, so a step ships with the arguments that make it work.
curriculum.steps[].args.*bodyany—
curriculum.steps[].depsbodystring[]—Dependencies are step ids that must be done/skipped before this step is available.
curriculum.steps[].detailbodystring—Detail is the juncture — what the Guide explains, or asks for, at this step.
curriculum.steps[].draftbodystring—Draft, when set, is the prompt the embedded AI answers first; its output is folded into one of Args before the tool runs, so the model writes the content and the tool only delivers it.
curriculum.steps[].draftIntobodystring—DraftInto names the argument the drafted text lands in.
curriculum.steps[].enabledbodyboolean—Enabled is the admin on/off lever.
curriculum.steps[].idbodystring—ID is the stable slug the whole plane addresses this step by — the value in deps, in next, in the progress rows, and in the URL of every step route.
curriculum.steps[].sectionbodystring—Section is the id of the phase this step groups under.
curriculum.steps[].signalbodystring—Signal, when set, names a machine detector (detect.go).
curriculum.steps[].titlebodystring—Title is the one-line quest as a person reads it in the checklist.
curriculum.steps[].toolbodystring—Tool, when set, names the MCP tool the Business AI runs for "do it for me".
curriculum.titlebodystring—Title is the playbook's name as it heads the checklist.
curriculum.versionbodystring—Version identifies the authored playbook this journey was projected from, so two orgs on different playbooks can be told apart.
custombodyboolean—Custom is true when the org's OWN curriculum override is active; false when the journey comes from the brand blueprint or the embedded fixture.

Failure carries the platform error shape — see Errors.

Examples

hanzo guide curriculum clear
import { Configuration, GuideApi } from 'hanzoai';

const api = new GuideApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteGuideCurriculum();
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).delete_guide_curriculum()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.GuideAPI.DeleteGuideCurriculum(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::delete_guide_curriculum(&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).deleteGuideCurriculum();
curl -X DELETE https://api.hanzo.ai/v1/guide/curriculum \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool guide, op delete_guide_curriculum — 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": "guide",
         "arguments": {
           "op": "delete_guide_curriculum",
           "input": {}
         }
       }
     }'

Guide API · All Hanzo APIs · Interactive reference

Was this page useful?