Workflows with Arazzo

Read the workflow contract

The Arazzo document publishes inputs, operation IDs, success criteria, and outputs. Its source description points to the live OpenAPI contract. Authenticate before running a workflow that creates data.

Create a project

create-project takes a name and optional description, calls createProject, and expects HTTP 201. It returns the project ID and URL. The project starts empty.

Start a block

start-block takes a name, finished width, and finished height in inches. It calls createBlock and expects HTTP 201, returning a block ID and Block Editor URL. The block starts with no pieces.

Start a design

1. Create an empty project with createProject.
2. Create an empty block stub with createBlock.
3. Search the shared fabric catalog with searchFabricCatalog.

start-design does not attach the block to the project or assign fabrics to pieces. Continue those steps in the app using the returned links. Existing quilts can be found with listQuilts; quilt assembly stays in the editor.

Handle partial completion

These workflows describe separate operations, not one atomic transaction. If a later step fails, earlier creates may already have succeeded. Keep returned IDs and URLs, inspect existing state, and resume carefully. Read Errors and retries before automatically replaying writes.