---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Workflows"
description: "The `workflows` collection of Sylphx Workflows: A Workflow is durable work a customer declares: the handler each step of a Run invokes, and its retry and timeout policy."
type: reference
product: workflows
summary: "A Workflow is durable work a customer declares: the handler each step of a Run invokes, and its retry and timeout policy."
updated: 2026-09-28
order: 900
---

A Workflow is durable work a customer declares: the handler each step of a Run invokes, and its retry and timeout policy. A Workflow write never starts, completes, or cancels a Run; a Run pins the Workflow generation it started from.

**Service** Sylphx Workflows · **Resource type** `workflows.sylphx.com/Workflow` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}` · **Shape** `spec_status`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}`. |
| `uid` | `string` | `wf_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `WorkflowSpec` | Desired state. Required. |
| `status` | `WorkflowStatus` | Observed state. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/workflows#get) | Gets a workflow. |
| `GET` | [`list`](/docs/api/workflows#list) | Lists workflows. |
| `POST` | [`create`](/docs/api/workflows#create) | Creates a workflow. |
| `PATCH` | [`update`](/docs/api/workflows#update) | Updates a workflow. |
| `DELETE` | [`delete`](/docs/api/workflows#delete) | Deletes a workflow. |

## get

Gets a workflow.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow` · scope `workflows:read` · effect `read` · [Request, response and examples](/docs/api/workflows/get)

## list

Lists workflows.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows` · scope `workflows:read` · effect `read` · paginated · [Request, response and examples](/docs/api/workflows/list)

## create

Creates a workflow.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/workflows/create)

## update

Updates a workflow.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/workflows/update)

## delete

Deletes a workflow.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow` · scope `workflows:write` · effect `destructive` · [Request, response and examples](/docs/api/workflows/delete)