Sign in

v84

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0985248447.1 KB
Agents

Get a node type schema

Retrieve the JSON schema and worked examples for a single node type.

The schema field is an opaque JSON Schema for the node's configuration. Use schema_version as a cache key — it bumps whenever the schema changes.

get/v1/agents/node-types/{node_type}/schema

Path parameters

node_typestring required

The node type to fetch the schema for, e.g. llm.

The node type to fetch the schema for, e.g. llm.

Response

Successful Response

node_typestring required

Stable identifier for the node type, e.g. llm.

schemaobject required

Opaque JSON Schema for the node's configuration. Treat this as an arbitrary object; its internal shape can change between schema_version bumps.

schema_versionstring required

Opaque version string for the node schema. Bumps whenever the underlying schema changes, so it can be used as a client-side cache key.

descriptionstring nullable

Short description of what the node type does, if provided.

examplesobject[] nullable

Worked example configurations for the node type, in the canonical graph dialect. These are curated guidance maintained by external-api, versioned by docs_version (NOT schema_version): they illustrate a valid shape at curation time but are a starting point, not the contract — they may lag the validator. The authoritative contract is schema, and the only authoritative check that a graph is valid is publishing it (or the agent-validation endpoint). Do not parse examples as the schema.

documentationobject nullable

Opaque, human-oriented authoring guidance for the node type — purpose, constraints, enum values, and variable-flow notes that the machine schema does not always express (e.g. a conditional's else-branch rule, or an iteration's sub-graph shape). Treat as an arbitrary object; use docs_version as its cache key.

docs_versionstring nullable

Opaque version string for documentation/examples, independent of schema_version. Bumps when the authoring guidance changes even if the underlying machine schema did not. When it trails the live schema_version, treat documentation/examples as guidance that may be stale and validate against the live schema.