# Flowral Flows API

**Canonical:** https://apis.io/apis/flowral-app/flowral-app-flows-api/  
**Provider:** Flowral — https://apis.io/providers/flowral-app/  
**Base URL:** https://api.flowral.app  
**Documentation:** https://flowral.app/api/reference

Flowral Flows API is one of 10 APIs that [Flowral](https://apis.io/providers/flowral-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 3 JSON Schema definitions. Tagged areas include Flow. The published artifact set on APIs.io includes an OpenAPI specification and 3 JSON Schemas.

Projects, and everything that operates on a whole one.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/flows` | List flows |
| POST | `/v1/flows` | Create a flow |
| GET | `/v1/flows/{flowId}` | Get a flow |
| PATCH | `/v1/flows/{flowId}` | Update a flow |
| DELETE | `/v1/flows/{flowId}` | Archive a flow |
| POST | `/v1/flows/{flowId}/restore` | Restore an archived flow |
| GET | `/v1/flows/{flowId}/schedule` | Get the schedule |
| GET | `/v1/flows/{flowId}/report` | Get the delivery report |
| POST | `/v1/flows/{flowId}/exports` | Export a flow |
| GET | `/v1/flows/{flowId}/shares` | List a flow's guests |
| POST | `/v1/flows/{flowId}/shares` | Share a flow with a guest |
| POST | `/v1/flows/{flowId}/publish` | Publish a flow |
| DELETE | `/v1/flows/{flowId}/publish` | Un-publish a flow |
| DELETE | `/v1/flows/{flowId}/shares/{shareId}` | Remove a guest from a flow |

## Machine-readable artifacts (4)

- **OpenAPI** — https://artifacts.apis.io/flowral-app/openapi/flowral-app-flows-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/flowral-app/json-schema/flowral-app-task-schema.json
- **JSONSchema** — https://artifacts.apis.io/flowral-app/json-schema/flowral-app-report-schema.json
- **JSONSchema** — https://artifacts.apis.io/flowral-app/json-schema/flowral-app-flow-summary-schema.json

## Other Flowral APIs (9)

- [Flowral Auth API](https://apis.io/apis/flowral-app/flowral-app-auth-api/)
- [Flowral Brainstorms API](https://apis.io/apis/flowral-app/flowral-app-brainstorms-api/)
- [Flowral Notifications API](https://apis.io/apis/flowral-app/flowral-app-notifications-api/)
- [Flowral Search API](https://apis.io/apis/flowral-app/flowral-app-search-api/)
- [Flowral Tasks API](https://apis.io/apis/flowral-app/flowral-app-tasks-api/)
- [Flowral Team API](https://apis.io/apis/flowral-app/flowral-app-team-api/)
- [Flowral Templates API](https://apis.io/apis/flowral-app/flowral-app-templates-api/)
- [Flowral Work API](https://apis.io/apis/flowral-app/flowral-app-work-api/)
- [Flowral Workspace API](https://apis.io/apis/flowral-app/flowral-app-workspace-api/)

## Tags

Flow

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/flowral-app/flowral-app-flows-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/flowral-app/.