# Compelling Workflows API

**Canonical:** https://apis.io/apis/compelling-ai/compelling-ai-workflows-api/  
**Provider:** Compelling — https://apis.io/providers/compelling-ai/  
**Base URL:** https://api.compelling.ai/v1  
**Documentation:** https://docs.compelling.ai/

Compelling Workflows API is one of 11 APIs that [Compelling](https://apis.io/providers/compelling-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

Ordered research pipelines that run a series of enrichment steps against a list.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| GET | `/workspaces/{workspace_id}/lists/{list_id}/workflows` | List workflows |
| POST | `/workspaces/{workspace_id}/lists/{list_id}/workflows` | Create a workflow |
| GET | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}` | Get a workflow |
| PATCH | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}` | Update a workflow |
| DELETE | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}` | Delete a workflow |
| POST | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/run` | Run a workflow |
| DELETE | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/pending` | Cancel a running workflow |
| GET | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps` | List steps |
| POST | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps` | Add a step |
| POST | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps/reorder` | Reorder steps |
| PATCH | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps/{step_id}` | Update a step |
| DELETE | `/workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps/{step_id}` | Remove a step |

## Machine-readable artifacts (4)

- **OpenAPI** — https://artifacts.apis.io/compelling-ai/openapi/compelling-ai-workflows-api-openapi.yml
- **Documentation** — https://docs.compelling.ai/
- **JSONSchema** — https://artifacts.apis.io/compelling-ai/json-schema/compelling-ai-job-schema.json
- **JSONSchema** — https://artifacts.apis.io/compelling-ai/json-schema/compelling-ai-workflow-schema.json

## Other Compelling APIs (10)

- [Compelling Accounts API](https://apis.io/apis/compelling-ai/compelling-ai-accounts-api/)
- [Compelling Contacts API](https://apis.io/apis/compelling-ai/compelling-ai-contacts-api/)
- [Compelling Credits API](https://apis.io/apis/compelling-ai/compelling-ai-credits-api/)
- [Compelling Exports API](https://apis.io/apis/compelling-ai/compelling-ai-exports-api/)
- [Compelling Integrations API](https://apis.io/apis/compelling-ai/compelling-ai-integrations-api/)
- [Compelling Jobs API](https://apis.io/apis/compelling-ai/compelling-ai-jobs-api/)
- [Compelling Lists API](https://apis.io/apis/compelling-ai/compelling-ai-lists-api/)
- [Compelling Search API](https://apis.io/apis/compelling-ai/compelling-ai-search-api/)
- [Compelling Views API](https://apis.io/apis/compelling-ai/compelling-ai-views-api/)
- [Compelling Workspaces API](https://apis.io/apis/compelling-ai/compelling-ai-workspaces-api/)

## Tags

Workflows

---

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