Humanitec API — Artefact

naftiko: 1.0.0-alpha2
info:
  label: Humanitec API — Artefact
  description: 'Humanitec API — Artefact. 4 operations. Lead operation: Get the Humanitec module definition of this Workload
    Artefact Version as a deployment set. Self-contained Naftiko capability covering one Humanitec business surface.'
  tags:
  - Humanitec
  - Artefact
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUMANITEC_API_KEY: HUMANITEC_API_KEY
capability:
  consumes:
  - type: http
    namespace: humanitec-artefact
    baseUri: https://api.humanitec.io
    description: Humanitec API — Artefact business capability. Self-contained, no shared references.
    resources:
    - name: orgs-orgId-artefact-versions-artefactVersionId-workload-deployment-set
      path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-deployment-set
      operations:
      - name: getworkloadartefactversiondeploymentset
        method: GET
        description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: artefactVersionId
          in: path
          type: string
          description: The Artefact Version ID.
          required: true
        - name: Accept
          in: header
          type: string
          description: The accepted content type.
    - name: orgs-orgId-artefact-versions-artefactVersionId-workload-spec
      path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-spec
      operations:
      - name: getworkloadartefactversionspec
        method: GET
        description: Get the spec of this Workload Artefact Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: artefactVersionId
          in: path
          type: string
          description: The Artefact Version ID.
          required: true
        - name: Accept
          in: header
          type: string
          description: The accepted content type.
    - name: orgs-orgId-artefacts
      path: /orgs/{orgId}/artefacts
      operations:
      - name: listartefacts
        method: GET
        description: List all Artefacts.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: type
          in: query
          type: string
          description: (Optional) Filter Artefacts by type.
        - name: name
          in: query
          type: string
          description: (Optional) Filter Artefacts by name.
    - name: orgs-orgId-artefacts-artefactId
      path: /orgs/{orgId}/artefacts/{artefactId}
      operations:
      - name: deleteartefact
        method: DELETE
        description: Delete Artefact and all related Artefact Versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: artefactId
          in: path
          type: string
          description: The Artefact ID.
          required: true
  exposes:
  - type: rest
    namespace: humanitec-artefact-rest
    port: 8080
    description: REST adapter for Humanitec API — Artefact. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/orgs/{orgid}/artefact-versions/{artefactversionid}/workload-deployment-set
      name: orgs-orgid-artefact-versions-artefactversionid-workload-deployment-set
      description: REST surface for orgs-orgId-artefact-versions-artefactVersionId-workload-deployment-set.
      operations:
      - method: GET
        name: getworkloadartefactversiondeploymentset
        description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set
        call: humanitec-artefact.getworkloadartefactversiondeploymentset
        with:
          orgId: rest.orgId
          artefactVersionId: rest.artefactVersionId
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/artefact-versions/{artefactversionid}/workload-spec
      name: orgs-orgid-artefact-versions-artefactversionid-workload-spec
      description: REST surface for orgs-orgId-artefact-versions-artefactVersionId-workload-spec.
      operations:
      - method: GET
        name: getworkloadartefactversionspec
        description: Get the spec of this Workload Artefact Version
        call: humanitec-artefact.getworkloadartefactversionspec
        with:
          orgId: rest.orgId
          artefactVersionId: rest.artefactVersionId
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/artefacts
      name: orgs-orgid-artefacts
      description: REST surface for orgs-orgId-artefacts.
      operations:
      - method: GET
        name: listartefacts
        description: List all Artefacts.
        call: humanitec-artefact.listartefacts
        with:
          orgId: rest.orgId
          type: rest.type
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/artefacts/{artefactid}
      name: orgs-orgid-artefacts-artefactid
      description: REST surface for orgs-orgId-artefacts-artefactId.
      operations:
      - method: DELETE
        name: deleteartefact
        description: Delete Artefact and all related Artefact Versions
        call: humanitec-artefact.deleteartefact
        with:
          orgId: rest.orgId
          artefactId: rest.artefactId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: humanitec-artefact-mcp
    port: 9090
    transport: http
    description: MCP adapter for Humanitec API — Artefact. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-humanitec-module-definition-this
      description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-artefact.getworkloadartefactversiondeploymentset
      with:
        orgId: tools.orgId
        artefactVersionId: tools.artefactVersionId
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: get-spec-this-workload-artefact
      description: Get the spec of this Workload Artefact Version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-artefact.getworkloadartefactversionspec
      with:
        orgId: tools.orgId
        artefactVersionId: tools.artefactVersionId
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-artefacts
      description: List all Artefacts.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-artefact.listartefacts
      with:
        orgId: tools.orgId
        type: tools.type
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-artefact-and-all-related
      description: Delete Artefact and all related Artefact Versions
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: humanitec-artefact.deleteartefact
      with:
        orgId: tools.orgId
        artefactId: tools.artefactId
      outputParameters:
      - type: object
        mapping: $.