Hanzo
OpenapiAuto

Run executes one connector action in-process and answers the outcome.

Run executes one connector action in-process and answers the outcome.

POST /v1/auto/connectors/{id}/run

Addresshttps://api.hanzo.ai/v1/auto/connectors/{id}/run
MethodPOST
Operationpost_auto_connectors_by_id_run
AuthAuthorization: Bearer $HANZO_API_KEY

Run executes one connector action in-process and answers the outcome. The caller's resolved credential travels in auth, delivered to the action verbatim — the runtime resolves no credential itself. An action that ran and failed (or an action name the connector does not have) answers ok:false with the failure message, not an HTTP error; an unknown connector is 404 and a missing action 422.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the connector to run, from the path.
actionbodystringAction is the name of the connector action to invoke.
authbodyobjectAuth is the caller's resolved credential for the connector, handed to the action verbatim.
idbodystringID is the connector to run, from the path.
propsbodyobjectProps are the action's input properties, keyed by property name.
props.*bodyobject

Response

StatusBodyMeaning
200runRespok

200 body — 3 fields.

FieldInTypeAlwaysDescription
errorbodystringError is the connector-level failure message when not ok.
okbodybooleanOk reports whether the action ran to completion.
outputbodyobjectOutput is the action's result when ok.

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.


Auto API · All Hanzo APIs · Interactive reference

How is this guide?

On this page