Compelling Workflows API

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

GitHub OpenAPI

Operations 12

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 #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/compelling-ai:compelling-ai-workflows-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

compelling-ai-workflows-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compelling Ai Workflows API
  version: 1.0.0
  contact:
    name: Compelling
    url: https://compelling.ai
  description: 'Operations tagged Workflows across 2 of this provider''s published API definitions: compelling-ai-openapi.yaml, compelling-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.compelling.ai/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Workflows
  description: Ordered research pipelines that run a series of enrichment steps against a list.
paths:
  /workspaces/{workspace_id}/lists/{list_id}/workflows:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    get:
      tags:
      - Workflows
      summary: List workflows
      operationId: getWorkflows
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Workflow'
    post:
      tags:
      - Workflows
      summary: Create a workflow
      operationId: createWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  example: ICP Enrichment Pipeline
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/workflow_id'
    get:
      tags:
      - Workflows
      summary: Get a workflow
      operationId: getWorkflow
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
    patch:
      tags:
      - Workflows
      summary: Update a workflow
      operationId: updateWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
    delete:
      tags:
      - Workflows
      summary: Delete a workflow
      operationId: deleteWorkflow
      responses:
        '204':
          description: Deleted
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/run:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/workflow_id'
    post:
      tags:
      - Workflows
      summary: Run a workflow
      description: Executes all steps in the workflow sequentially against the list's accounts and contacts.
      operationId: runWorkflow
      responses:
        '202':
          description: Run started
          headers:
            Location:
              description: URL to poll for job status.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/pending:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/workflow_id'
    delete:
      tags:
      - Workflows
      summary: Cancel a running workflow
      operationId: cancelWorkflow
      responses:
        '204':
          description: Cancelled
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/workflow_id'
    get:
      tags:
      - Workflows
      summary: List steps
      operationId: getSteps
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Step'
    post:
      tags:
      - Workflows
      summary: Add a step
      operationId: createStep
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StepInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Step'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps/reorder:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/workflow_id'
    post:
      tags:
      - Workflows
      summary: Reorder steps
      operationId: reorderSteps
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - step_ids
              properties:
                step_ids:
                  type: array
                  items:
                    type: string
                  description: Full ordered list of step IDs representing the desired sequence.
                  example:
                  - stp_03
                  - stp_01
                  - stp_02
      responses:
        '200':
          description: Reordered
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Step'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/workflows/{workflow_id}/steps/{step_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/workflow_id'
    - $ref: '#/components/parameters/step_id'
    patch:
      tags:
      - Workflows
      summary: Update a step
      operationId: updateStep
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StepInput'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Step'
    delete:
      tags:
      - Workflows
      summary: Remove a step
      operationId: deleteStep
      responses:
        '204':
          description: Removed
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
components:
  parameters:
    step_id:
      name: step_id
      in: path
      required: true
      schema:
        type: string
      example: stp_01HX
    list_id:
      name: list_id
      in: path
      required: true
      schema:
        type: string
      example: lst_01HX
    workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        type: string
      example: wfl_01HX
    workspace_id:
      name: workspace_id
      in: path
      required: true
      schema:
        type: string
      example: ws_01HX
  schemas:
    Job:
      type: object
      properties:
        job_id:
          type: string
          example: job_01HX
        status:
          type: string
          enum:
          - pending
          - running
          - complete
          - failed
          example: running
        type:
          type: string
          enum:
          - contact_generation
          - account_insight_answers
          - contact_insight_answers
          - workflow_run
          example: contact_generation
        list_id:
          type: string
          example: lst_01HX
        error:
          type: string
          nullable: true
          description: Error message if status is `failed`.
        result:
          type: object
          nullable: true
          description: Summary or result data when status is `complete`.
          additionalProperties: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Workflow:
      type: object
      properties:
        id:
          type: string
          example: wfl_01HX
        list_id:
          type: string
          example: lst_01HX
        name:
          type: string
          example: ICP Enrichment Pipeline
        status:
          type: string
          enum:
          - idle
          - running
          - complete
          - failed
        step_count:
          type: integer
          example: 3
        last_run_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
    StepInput:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - generate_contacts
          - account_insight
          - contact_insight
        config:
          type: object
          additionalProperties: true
          example:
            question: What is the company's primary ICP segment?
            column_name: icp_segment
    Step:
      type: object
      properties:
        id:
          type: string
          example: stp_01HX
        workflow_id:
          type: string
          example: wfl_01HX
        order:
          type: integer
          example: 1
        type:
          type: string
          enum:
          - generate_contacts
          - account_insight
          - contact_insight
        config:
          type: object
          additionalProperties: true
          description: Step-type-specific configuration (e.g. question text for insight steps).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key issued from your workspace settings. Pass as `Authorization: Bearer <token>`.'
x-refined-from:
- compelling-ai-openapi.yaml
- compelling-ai-openapi.yml