> For the complete documentation index, see [llms.txt](https://docs.nected.ai/nected-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nected.ai/nected-docs/management-api/workflow.md).

# Workflow

The Workflow API lets you list, create, read, update, test, and publish workflows in your workspace via the DevAPI v1. All paths use the entity type `workflow`.

**Workflow types:** Unlike rules, workflows have a single structure — a directed graph of **nodes** connected by **edges**. The request payload for create and update is the full graph; the response format is the same (create returns `data.id` and `data.checksum`; update returns `data.checksum`).

**Create vs get:** The JSON body you send to **create** a workflow matches the **`data` object** returned by **get workflow by id**, except create does not include `id`, `checksum`, `version`, `status`, `staticUrl`, `versionInfo`, or timestamps. Use the full payloads in openapi.yaml (Examples dropdown) and Create/create\_workflow\.json — not a minimal `{ name }` stub.

**List vs get:** `GET /dev/v1/workflow` returns **summary rows** plus `paginationInfo` (see Get/GET\_ALL.json), not the full workflow graph.

**Scheduling is not supported for workflows.** Only [rules support scheduling](/nected-docs/management-api/rules/create-or-update-schedule-rule.md).

### Base URL

All endpoints are prefixed with `/dev/v1/workflow`.

### Authentication

| Header           | Type   | Required | Description             |
| ---------------- | ------ | -------- | ----------------------- |
| `Nected-API-Key` | string | Yes      | Your Nected API key.    |
| `Nected-Branch`  | string | No       | Branch name (optional). |

***

### Endpoints

| Method | Path                                   | Description              |
| ------ | -------------------------------------- | ------------------------ |
| GET    | `/dev/v1/workflow`                     | List workflows (Get all) |
| POST   | `/dev/v1/workflow`                     | Create workflow          |
| GET    | `/dev/v1/workflow/{entity-id}`         | Get workflow by id       |
| PATCH  | `/dev/v1/workflow/{entity-id}`         | Update workflow          |
| POST   | `/dev/v1/workflow/{entity-id}/test`    | Test workflow            |
| POST   | `/dev/v1/workflow/{entity-id}/publish` | Publish workflow         |
| GET    | `/dev/v1/workflow/{entity-id}/version` | List published versions  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nected.ai/nected-docs/management-api/workflow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.