Hanzo
OpenapiBot

Stop terminates one of the caller org's own bot runs and reports its terminal…

Stop terminates one of the caller org's own bot runs and reports its terminal state.

POST /v1/bot/runs/{runId}/stop

Addresshttps://api.hanzo.ai/v1/bot/runs/{runId}/stop
MethodPOST
Operationpost_bot_runs_by_runid_stop
AuthAuthorization: Bearer $HANZO_API_KEY

Stop terminates one of the caller org's own bot runs and reports its terminal state.

The own-key guard is the org: it is the caller's validated org, never theirs to choose, and the runtime resolves the run id UNDER it. A run belonging to another tenant is not among this org's runs, so it answers absent — the same 404 a nonexistent id gets, which is what keeps this from being an oracle.

Absence is honoured ONLY when the runtime answers it. A runtime that does not serve stop reports nothing about the run, and reporting "stopped" on that basis would be a stop that cannot fail — so it is a 502.

Request

1 field.

FieldInTypeRequiredDescription
runIdpathstringyes

Response

StatusBodyMeaning
200BotStoppedok

200 body — 2 fields.

FieldInTypeAlwaysDescription
runIdbodystringRunID is the run that was stopped.
statusbodystringStatus is the run's terminal state: "stopped".

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Bot API · All Hanzo APIs · Interactive reference

How is this guide?

On this page