Workflow guide
Complete a first workflow
Follow a small end-to-end example and verify its result.
Confirm the enabled version and permissions in your environment. These guides do not announce a general release.
Before you start
An API environment, a valid identity, a flow definition and credentials for only the providers the flow needs. Use the environment-specific OpenAPI contract.
Steps
- Select the environment and a versioned flow definition. Start with a deterministic step before adding a model or tool with side effects.
- Validate the input schema and choose the request behavior: sync, wait or async. Keep the returned run identifier for subsequent inspection.
- Inspect the run state and output. Exercise a controlled timeout or pause in a test environment, then verify continuation without repeating a completed effect.
Check the result
Inspect the run state and output. Exercise a controlled timeout or pause in a test environment, then verify continuation without repeating a completed effect.
If it does not work
Use run, flow and correlation identifiers to distinguish input validation, model/provider, tool and worker failures. Confirm run state before retrying.