get_workflow_schema
Describe the authoring contract for creating and editing workflows. Call this before create_workflow or update_workflow — it is the source of truth for the node/edge JSON shapes, the catalog of node types, and the variable-reference syntax.
Parameters#
None.
Returns#
| Field | Description |
|---|---|
node_config_format | The JSON object shape for entries in node_config |
edge_config_format | The JSON object shape for entries in edge_config |
node_types | Per-type purpose + accepted data fields (trigger, llm, tool_call, knowledge_base, assistant, …) |
variable_references | The @{node___var} syntax for referencing upstream node outputs |
node_credentials | How to assign credential accounts to credentialed nodes |
rules | Authoring constraints (one trigger per workflow, preview-first, …) |
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid / revoked API key |
See also#
list_authoring_resources— real ids to plug into nodedatafieldscreate_workflow/update_workflow— where this contract is consumed