Fivexer

Fivexer Workflow Runs API

The workflow-runs API from Fivexer — 7 operation(s) for workflow-runs.

Documentation GitHub OpenAPI

Operations 8

POST /v1/workflows/{id}/runs Start a workflow run #

GET /v1/workflows/{id}/runs List runs of a workflow definition #

GET /v1/workflow-runs List workflow runs #

GET /v1/workflow-runs/{runId} Get a workflow run #

GET /v1/workflow-runs/{runId}/steps Get a run's per-step state #

POST /v1/workflow-runs/{runId}/cancel Cancel a workflow run #

POST /v1/workflow-runs/{runId}/steps/{stepId}/complete Complete an external workflow step #

POST /v1/workflow-runs/{runId}/steps/{stepId}/fail Fail an external workflow step #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/5xer-com/openapi/5xer-com-workflow-runs-api-openapi.yml

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/5xer-com:5xer-com-workflow-runs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Fivexer Platform Workflow Runs API
  description: 'Routing-as-a-service: create workers and tasks, the platform matches continuously. `/v1` authenticates with a workspace API key (`Authorization: Bearer sk_...`); `/console` with a session token from `/auth`; `/admin` with the operator token.'
  version: 0.1.0
servers:
- url: https://5xer.com
  description: This deployment
tags:
- name: workflow-runs
paths:
  /v1/workflows/{id}/runs:
    post:
      summary: Start a workflow run
      tags:
      - workflow-runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                context:
                  type: object
                initiatorWorkerId:
                  type: string
                  minLength: 1
                  maxLength: 128
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1WorkflowsByIdRuns
      x-operation-id-source: derived
    get:
      summary: List runs of a workflow definition
      tags:
      - workflow-runs
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: getV1WorkflowsByIdRuns
      x-operation-id-source: derived
  /v1/workflow-runs:
    get:
      summary: List workflow runs
      tags:
      - workflow-runs
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      operationId: getV1WorkflowRuns
      x-operation-id-source: derived
  /v1/workflow-runs/{runId}:
    get:
      summary: Get a workflow run
      tags:
      - workflow-runs
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: runId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: getV1WorkflowRunsByRunId
      x-operation-id-source: derived
  /v1/workflow-runs/{runId}/steps:
    get:
      summary: Get a run's per-step state
      tags:
      - workflow-runs
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: runId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: getV1WorkflowRunsByRunIdSteps
      x-operation-id-source: derived
  /v1/workflow-runs/{runId}/cancel:
    post:
      summary: Cancel a workflow run
      tags:
      - workflow-runs
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: runId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1WorkflowRunsByRunIdCancel
      x-operation-id-source: derived
  /v1/workflow-runs/{runId}/steps/{stepId}/complete:
    post:
      summary: Complete an external workflow step
      tags:
      - workflow-runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                data:
                  type: object
                error:
                  type: string
                  maxLength: 2000
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: runId
        required: true
      - schema:
          type: string
        in: path
        name: stepId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1WorkflowRunsByRunIdStepsByStepIdComplete
      x-operation-id-source: derived
  /v1/workflow-runs/{runId}/steps/{stepId}/fail:
    post:
      summary: Fail an external workflow step
      tags:
      - workflow-runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                data:
                  type: object
                error:
                  type: string
                  maxLength: 2000
      security:
      - apiKey: []
      parameters:
      - schema:
          type: string
        in: path
        name: runId
        required: true
      - schema:
          type: string
        in: path
        name: stepId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1WorkflowRunsByRunIdStepsByStepIdFail
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Workspace API key (sk_test_/sk_live_)
    session:
      type: http
      scheme: bearer
      description: Console session token (st_...)
    adminToken:
      type: http
      scheme: bearer
      description: Operator ADMIN_TOKEN
    workerToken:
      type: http
      scheme: bearer
      description: Worker session token (wt_...)
    supervisorToken:
      type: http
      scheme: bearer
      description: Supervisor session token (sv_...), scoped to one workspace and optionally one team