ZenML OSS REST API — Pipeline Runs

naftiko: 1.0.0-alpha2
info:
  label: ZenML OSS REST API — Pipeline Runs
  description: 'ZenML OSS REST API — Pipeline Runs. 2 operations. Lead operation: List Pipeline Runs. Self-contained Naftiko
    capability covering one Zenml business surface.'
  tags:
  - Zenml
  - Pipeline Runs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZENML_API_KEY: ZENML_API_KEY
capability:
  consumes:
  - type: http
    namespace: zenml-pipeline-runs
    baseUri: https://your-zenml-server.example.com/api/v1
    description: ZenML OSS REST API — Pipeline Runs business capability. Self-contained, no shared references.
    resources:
    - name: runs
      path: /runs
      operations:
      - name: listpipelineruns
        method: GET
        description: List Pipeline Runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pipeline_id
          in: query
          type: string
        - name: status
          in: query
          type: string
    - name: runs-run_id
      path: /runs/{run_id}
      operations:
      - name: getpipelinerun
        method: GET
        description: Get Pipeline Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ZENML_API_KEY}}'
  exposes:
  - type: rest
    namespace: zenml-pipeline-runs-rest
    port: 8080
    description: REST adapter for ZenML OSS REST API — Pipeline Runs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/runs
      name: runs
      description: REST surface for runs.
      operations:
      - method: GET
        name: listpipelineruns
        description: List Pipeline Runs
        call: zenml-pipeline-runs.listpipelineruns
        with:
          pipeline_id: rest.pipeline_id
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/runs/{run-id}
      name: runs-run-id
      description: REST surface for runs-run_id.
      operations:
      - method: GET
        name: getpipelinerun
        description: Get Pipeline Run
        call: zenml-pipeline-runs.getpipelinerun
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: zenml-pipeline-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZenML OSS REST API — Pipeline Runs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-pipeline-runs
      description: List Pipeline Runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zenml-pipeline-runs.listpipelineruns
      with:
        pipeline_id: tools.pipeline_id
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pipeline-run
      description: Get Pipeline Run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zenml-pipeline-runs.getpipelinerun
      outputParameters:
      - type: object
        mapping: $.