Skip to main content
Official templates are CogFoundry-maintained workflows intended to provide the shortest path from structured input to a repeatable result.

​
Discover what is available

Availability can vary by environment and permission. Treat this command as the source of truth rather than relying on a static catalog. The current repository documents these template IDs as common examples. Confirm each one against the configured service before use: If an ID does not appear in template list, it is not available to your current environment.

​
Inspect the current schema

The schema is the authoritative definition of:
  • required and optional fields;
  • exact field keys and labels;
  • allowed values and examples;
  • the current template version.
After submission, keep the returned run ID and use the run and result commands.
Download a fresh workbook when the template schema changes. Do not assume an older workbook remains compatible with the currently available template version.

​
Programmatic JSON or JSONL flow

For programmatic input, keep validation, estimation, and execution separate:
validate and precheck do not create a run. execute creates the run and returns its runId. It also accepts an optional --callback-url <https-url>.
The former combined run submit command is legacy and hidden. Use run validate, run precheck, and run execute for new integrations. --idempotency-key remains a deprecated alias for --client-request-id and should not be used in new scripts.