Postman APIs API

naftiko: 1.0.0-alpha2
info:
  label: Postman APIs API
  description: 'Postman APIs API. 5 operations. Lead operation: Postman Get all APIs. Self-contained Naftiko capability covering
    one Postman business surface.'
  tags:
  - Postman
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POSTMAN_API_KEY: POSTMAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: apis-general
    baseUri: https://api.getpostman.com
    description: Postman APIs API business capability. Self-contained, no shared references.
    resources:
    - name: apis
      path: /apis
      operations:
      - name: getallapis
        method: GET
        description: Postman Get all APIs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace
          in: query
          type: string
          description: The workspace ID to get APIs from. Required.
          required: true
        - name: cursor
          in: query
          type: string
          description: Pagination cursor.
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return.
        - name: createdBy
          in: query
          type: integer
          description: Filter by creator user ID.
        - name: description
          in: query
          type: string
          description: Filter by description text (partial match).
        - name: name
          in: query
          type: string
          description: Filter by API name (partial match).
      - name: createapi
        method: POST
        description: Postman Create an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace
          in: query
          type: string
          description: The workspace ID to create the API in. Required.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: apis-apiId
      path: /apis/{apiId}
      operations:
      - name: getapi
        method: GET
        description: Postman Get an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include
          in: query
          type: array
          description: Additional data to include in the response.
      - name: updateapi
        method: PUT
        description: Postman Update an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapi
        method: DELETE
        description: Postman Delete an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: x-api-key
      value: '{{env.POSTMAN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: apis-general-rest
    port: 8080
    description: REST adapter for Postman APIs API. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/apis
      name: apis
      description: REST surface for apis.
      operations:
      - method: GET
        name: getallapis
        description: Postman Get all APIs
        call: apis-general.getallapis
        with:
          workspace: rest.workspace
          cursor: rest.cursor
          limit: rest.limit
          createdBy: rest.createdBy
          description: rest.description
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapi
        description: Postman Create an API
        call: apis-general.createapi
        with:
          workspace: rest.workspace
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/apis/{apiid}
      name: apis-apiid
      description: REST surface for apis-apiId.
      operations:
      - method: GET
        name: getapi
        description: Postman Get an API
        call: apis-general.getapi
        with:
          include: rest.include
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateapi
        description: Postman Update an API
        call: apis-general.updateapi
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapi
        description: Postman Delete an API
        call: apis-general.deleteapi
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: apis-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for Postman APIs API. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: postman-get-all-apis
      description: Postman Get all APIs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: apis-general.getallapis
      with:
        workspace: tools.workspace
        cursor: tools.cursor
        limit: tools.limit
        createdBy: tools.createdBy
        description: tools.description
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: postman-create-api
      description: Postman Create an API
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: apis-general.createapi
      with:
        workspace: tools.workspace
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: postman-get-api
      description: Postman Get an API
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: apis-general.getapi
      with:
        include: tools.include
      outputParameters:
      - type: object
        mapping: $.
    - name: postman-update-api
      description: Postman Update an API
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: apis-general.updateapi
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: postman-delete-api
      description: Postman Delete an API
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: apis-general.deleteapi
      outputParameters:
      - type: object
        mapping: $.