Microsoft Azure TrainingApi — ProjectApi

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure TrainingApi — ProjectApi
  description: 'Microsoft Azure TrainingApi — ProjectApi. 15 operations. Lead operation: Microsoft Azure Get Your Projects.
    Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - ProjectApi
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: trainingapi-projectapi
    baseUri: https://southcentralus.api.cognitive.microsoft.com/customvision/v2.1/Training
    description: Microsoft Azure TrainingApi — ProjectApi business capability. Self-contained, no shared references.
    resources:
    - name: projects
      path: /projects
      operations:
      - name: microsoftazuregetprojects
        method: GET
        description: Microsoft Azure Get Your Projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: microsoftazurecreateproject
        method: POST
        description: Microsoft Azure Create A Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Name of the project
          required: true
        - name: description
          in: query
          type: string
          description: The description of the project
        - name: domainId
          in: query
          type: string
          description: The id of the domain to use for this project. Defaults to General
        - name: classificationType
          in: query
          type: string
          description: The type of classifier to create for this project
    - name: projects-projectId
      path: /projects/{projectId}
      operations:
      - name: microsoftazuregetproject
        method: GET
        description: Microsoft Azure Get A Specific Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The id of the project to get
          required: true
      - name: microsoftazuredeleteproject
        method: DELETE
        description: Microsoft Azure Delete A Specific Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
      - name: microsoftazureupdateproject
        method: PATCH
        description: Microsoft Azure Update A Specific Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The id of the project to update
          required: true
        - name: updatedProject
          in: body
          type: string
          description: The updated project model
          required: true
    - name: projects-projectId-iterations
      path: /projects/{projectId}/iterations
      operations:
      - name: microsoftazuregetiterations
        method: GET
        description: Microsoft Azure Get Iterations For The Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
    - name: projects-projectId-iterations-iterationId
      path: /projects/{projectId}/iterations/{iterationId}
      operations:
      - name: microsoftazuregetiteration
        method: GET
        description: Microsoft Azure Get A Specific Iteration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The id of the project the iteration belongs to
          required: true
        - name: iterationId
          in: path
          type: string
          description: The id of the iteration to get
          required: true
      - name: microsoftazuredeleteiteration
        method: DELETE
        description: Microsoft Azure Delete A Specific Iteration Of A Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
        - name: iterationId
          in: path
          type: string
          description: The iteration id
          required: true
      - name: microsoftazureupdateiteration
        method: PATCH
        description: Microsoft Azure Update A Specific Iteration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: Project id
          required: true
        - name: iterationId
          in: path
          type: string
          description: Iteration id
          required: true
        - name: updatedIteration
          in: body
          type: string
          description: The updated iteration model
          required: true
    - name: projects-projectId-iterations-iterationId-export
      path: /projects/{projectId}/iterations/{iterationId}/export
      operations:
      - name: microsoftazuregetexports
        method: GET
        description: Microsoft Azure Get The List Of Exports For A Specific Iteration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
        - name: iterationId
          in: path
          type: string
          description: The iteration id
          required: true
      - name: microsoftazureexportiteration
        method: POST
        description: Microsoft Azure Export A Trained Iteration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
        - name: iterationId
          in: path
          type: string
          description: The iteration id
          required: true
        - name: platform
          in: query
          type: string
          description: The target platform (coreml or tensorflow)
          required: true
        - name: flavor
          in: query
          type: string
          description: The flavor of the target platform (Windows, Linux, ARM, or GPU)
    - name: projects-projectId-iterations-iterationId-performance
      path: /projects/{projectId}/iterations/{iterationId}/performance
      operations:
      - name: microsoftazuregetiterationperformance
        method: GET
        description: Microsoft Azure Get Detailed Performance Information About An Iteration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The id of the project the iteration belongs to
          required: true
        - name: iterationId
          in: path
          type: string
          description: The id of the iteration to get
          required: true
        - name: threshold
          in: query
          type: number
          description: The threshold used to determine true predictions
        - name: overlapThreshold
          in: query
          type: number
          description: If applicable, the bounding box overlap threshold used to determine true predictions
    - name: projects-projectId-iterations-iterationId-performance-images
      path: /projects/{projectId}/iterations/{iterationId}/performance/images
      operations:
      - name: microsoftazuregetimageperformances
        method: GET
        description: Microsoft Azure Get Image With Its Prediction For A Given Project Iteration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
        - name: iterationId
          in: path
          type: string
          description: The iteration id. Defaults to workspace
          required: true
        - name: tagIds
          in: query
          type: array
          description: A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20
        - name: orderBy
          in: query
          type: string
          description: The ordering. Defaults to newest
        - name: take
          in: query
          type: integer
          description: Maximum number of images to return. Defaults to 50, limited to 256
        - name: skip
          in: query
          type: integer
          description: Number of images to skip before beginning the image batch. Defaults to 0
    - name: projects-projectId-iterations-iterationId-performance-images-count
      path: /projects/{projectId}/iterations/{iterationId}/performance/images/count
      operations:
      - name: microsoftazuregetimageperformancecount
        method: GET
        description: "Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids} That Have Prediction Results\
          \ From\r"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
        - name: iterationId
          in: path
          type: string
          description: The iteration id. Defaults to workspace
          required: true
        - name: tagIds
          in: query
          type: array
          description: A list of tags ids to filter the images to count. Defaults to all tags when null.
    - name: projects-projectId-train
      path: /projects/{projectId}/train
      operations:
      - name: microsoftazuretrainproject
        method: POST
        description: Microsoft Azure Queues Project For Training
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The project id
          required: true
  exposes:
  - type: rest
    namespace: trainingapi-projectapi-rest
    port: 8080
    description: REST adapter for Microsoft Azure TrainingApi — ProjectApi. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects
      name: projects
      description: REST surface for projects.
      operations:
      - method: GET
        name: microsoftazuregetprojects
        description: Microsoft Azure Get Your Projects
        call: trainingapi-projectapi.microsoftazuregetprojects
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazurecreateproject
        description: Microsoft Azure Create A Project
        call: trainingapi-projectapi.microsoftazurecreateproject
        with:
          name: rest.name
          description: rest.description
          domainId: rest.domainId
          classificationType: rest.classificationType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}
      name: projects-projectid
      description: REST surface for projects-projectId.
      operations:
      - method: GET
        name: microsoftazuregetproject
        description: Microsoft Azure Get A Specific Project
        call: trainingapi-projectapi.microsoftazuregetproject
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazuredeleteproject
        description: Microsoft Azure Delete A Specific Project
        call: trainingapi-projectapi.microsoftazuredeleteproject
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: microsoftazureupdateproject
        description: Microsoft Azure Update A Specific Project
        call: trainingapi-projectapi.microsoftazureupdateproject
        with:
          projectId: rest.projectId
          updatedProject: rest.updatedProject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/iterations
      name: projects-projectid-iterations
      description: REST surface for projects-projectId-iterations.
      operations:
      - method: GET
        name: microsoftazuregetiterations
        description: Microsoft Azure Get Iterations For The Project
        call: trainingapi-projectapi.microsoftazuregetiterations
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/iterations/{iterationid}
      name: projects-projectid-iterations-iterationid
      description: REST surface for projects-projectId-iterations-iterationId.
      operations:
      - method: GET
        name: microsoftazuregetiteration
        description: Microsoft Azure Get A Specific Iteration
        call: trainingapi-projectapi.microsoftazuregetiteration
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazuredeleteiteration
        description: Microsoft Azure Delete A Specific Iteration Of A Project
        call: trainingapi-projectapi.microsoftazuredeleteiteration
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: microsoftazureupdateiteration
        description: Microsoft Azure Update A Specific Iteration
        call: trainingapi-projectapi.microsoftazureupdateiteration
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
          updatedIteration: rest.updatedIteration
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/iterations/{iterationid}/export
      name: projects-projectid-iterations-iterationid-export
      description: REST surface for projects-projectId-iterations-iterationId-export.
      operations:
      - method: GET
        name: microsoftazuregetexports
        description: Microsoft Azure Get The List Of Exports For A Specific Iteration
        call: trainingapi-projectapi.microsoftazuregetexports
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureexportiteration
        description: Microsoft Azure Export A Trained Iteration
        call: trainingapi-projectapi.microsoftazureexportiteration
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
          platform: rest.platform
          flavor: rest.flavor
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/iterations/{iterationid}/performance
      name: projects-projectid-iterations-iterationid-performance
      description: REST surface for projects-projectId-iterations-iterationId-performance.
      operations:
      - method: GET
        name: microsoftazuregetiterationperformance
        description: Microsoft Azure Get Detailed Performance Information About An Iteration
        call: trainingapi-projectapi.microsoftazuregetiterationperformance
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
          threshold: rest.threshold
          overlapThreshold: rest.overlapThreshold
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/iterations/{iterationid}/performance/images
      name: projects-projectid-iterations-iterationid-performance-images
      description: REST surface for projects-projectId-iterations-iterationId-performance-images.
      operations:
      - method: GET
        name: microsoftazuregetimageperformances
        description: Microsoft Azure Get Image With Its Prediction For A Given Project Iteration
        call: trainingapi-projectapi.microsoftazuregetimageperformances
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
          tagIds: rest.tagIds
          orderBy: rest.orderBy
          take: rest.take
          skip: rest.skip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/iterations/{iterationid}/performance/images/count
      name: projects-projectid-iterations-iterationid-performance-images-count
      description: REST surface for projects-projectId-iterations-iterationId-performance-images-count.
      operations:
      - method: GET
        name: microsoftazuregetimageperformancecount
        description: "Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids} That Have Prediction Results\
          \ From\r"
        call: trainingapi-projectapi.microsoftazuregetimageperformancecount
        with:
          projectId: rest.projectId
          iterationId: rest.iterationId
          tagIds: rest.tagIds
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/train
      name: projects-projectid-train
      description: REST surface for projects-projectId-train.
      operations:
      - method: POST
        name: microsoftazuretrainproject
        description: Microsoft Azure Queues Project For Training
        call: trainingapi-projectapi.microsoftazuretrainproject
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: trainingapi-projectapi-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure TrainingApi — ProjectApi. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: microsoft-azure-get-your-projects
      description: Microsoft Azure Get Your Projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetprojects
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-create-project
      description: Microsoft Azure Create A Project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: trainingapi-projectapi.microsoftazurecreateproject
      with:
        name: tools.name
        description: tools.description
        domainId: tools.domainId
        classificationType: tools.classificationType
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-specific-project
      description: Microsoft Azure Get A Specific Project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetproject
      with:
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-delete-specific-project
      description: Microsoft Azure Delete A Specific Project
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: trainingapi-projectapi.microsoftazuredeleteproject
      with:
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-update-specific-project
      description: Microsoft Azure Update A Specific Project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazureupdateproject
      with:
        projectId: tools.projectId
        updatedProject: tools.updatedProject
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-iterations-project
      description: Microsoft Azure Get Iterations For The Project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetiterations
      with:
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-specific-iteration
      description: Microsoft Azure Get A Specific Iteration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetiteration
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-delete-specific-iteration
      description: Microsoft Azure Delete A Specific Iteration Of A Project
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: trainingapi-projectapi.microsoftazuredeleteiteration
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-update-specific-iteration
      description: Microsoft Azure Update A Specific Iteration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazureupdateiteration
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
        updatedIteration: tools.updatedIteration
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-list-exports
      description: Microsoft Azure Get The List Of Exports For A Specific Iteration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetexports
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-export-trained-iteration
      description: Microsoft Azure Export A Trained Iteration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: trainingapi-projectapi.microsoftazureexportiteration
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
        platform: tools.platform
        flavor: tools.flavor
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-detailed-performance
      description: Microsoft Azure Get Detailed Performance Information About An Iteration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetiterationperformance
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
        threshold: tools.threshold
        overlapThreshold: tools.overlapThreshold
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-image-its
      description: Microsoft Azure Get Image With Its Prediction For A Given Project Iteration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetimageperformances
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
        tagIds: tools.tagIds
        orderBy: tools.orderBy
        take: tools.take
        skip: tools.skip
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-gets-number-images
      description: "Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids} That Have Prediction Results\
        \ From\r"
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trainingapi-projectapi.microsoftazuregetimageperformancecount
      with:
        projectId: tools.projectId
        iterationId: tools.iterationId
        tagIds: tools.tagIds
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-queues-project-training
      description: Microsoft Azure Queues Project For Training
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: trainingapi-projectapi.microsoftazuretrainproject
      with:
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.