ZenML OSS REST API — Models

naftiko: 1.0.0-alpha2
info:
  label: ZenML OSS REST API — Models
  description: 'ZenML OSS REST API — Models. 3 operations. Lead operation: List Model Versions. Self-contained Naftiko capability
    covering one Zenml business surface.'
  tags:
  - Zenml
  - Models
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZENML_API_KEY: ZENML_API_KEY
capability:
  consumes:
  - type: http
    namespace: zenml-models
    baseUri: https://your-zenml-server.example.com/api/v1
    description: ZenML OSS REST API — Models business capability. Self-contained, no shared references.
    resources:
    - name: model_versions
      path: /model_versions
      operations:
      - name: listmodelversions
        method: GET
        description: List Model Versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: model_id
          in: query
          type: string
    - name: models
      path: /models
      operations:
      - name: listmodels
        method: GET
        description: List Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createmodel
        method: POST
        description: Create Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ZENML_API_KEY}}'
  exposes:
  - type: rest
    namespace: zenml-models-rest
    port: 8080
    description: REST adapter for ZenML OSS REST API — Models. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/model-versions
      name: model-versions
      description: REST surface for model_versions.
      operations:
      - method: GET
        name: listmodelversions
        description: List Model Versions
        call: zenml-models.listmodelversions
        with:
          model_id: rest.model_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/models
      name: models
      description: REST surface for models.
      operations:
      - method: GET
        name: listmodels
        description: List Models
        call: zenml-models.listmodels
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createmodel
        description: Create Model
        call: zenml-models.createmodel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: zenml-models-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZenML OSS REST API — Models. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-model-versions
      description: List Model Versions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zenml-models.listmodelversions
      with:
        model_id: tools.model_id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-models
      description: List Models
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zenml-models.listmodels
      outputParameters:
      - type: object
        mapping: $.
    - name: create-model
      description: Create Model
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zenml-models.createmodel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.