Blockfrost.io ~ API Documentation — IPFS » Pins

naftiko: 1.0.0-alpha2
info:
  label: Blockfrost.io ~ API Documentation — IPFS » Pins
  description: 'Blockfrost.io ~ API Documentation — IPFS » Pins. 4 operations. Lead operation: Blockfrost Pin an Object. Self-contained
    Naftiko capability covering one Blockfrost business surface.'
  tags:
  - Blockfrost
  - IPFS » Pins
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BLOCKFROST_API_KEY: BLOCKFROST_API_KEY
capability:
  consumes:
  - type: http
    namespace: blockfrost-ipfs-pins
    baseUri: https://cardano-mainnet.blockfrost.io/api/v0
    description: Blockfrost.io ~ API Documentation — IPFS » Pins business capability. Self-contained, no shared references.
    resources:
    - name: ipfs-pin-add-IPFS_path
      path: /ipfs/pin/add/{IPFS_path}
      operations:
      - name: post
        method: POST
        description: Blockfrost Pin an Object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: IPFS_path
          in: path
          type: string
          required: true
        - name: filecoin
          in: query
          type: boolean
          description: If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only
            be pinned to IPFS. Objects pinned to Filecoin cannot be un
    - name: ipfs-pin-list
      path: /ipfs/pin/list
      operations:
      - name: get
        method: GET
        description: Blockfrost List Pinned Objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: count
          in: query
          type: integer
          description: The number of results displayed on one page.
        - name: page
          in: query
          type: integer
          description: The page number for listing the results.
        - name: order
          in: query
          type: string
          description: The ordering of items from the point of view of the blockchain,
    - name: ipfs-pin-list-IPFS_path
      path: /ipfs/pin/list/{IPFS_path}
      operations:
      - name: get
        method: GET
        description: Blockfrost Get Details About Pinned Object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: IPFS_path
          in: path
          type: string
          required: true
    - name: ipfs-pin-remove-IPFS_path
      path: /ipfs/pin/remove/{IPFS_path}
      operations:
      - name: post
        method: POST
        description: Blockfrost Remove a IPFS Pin
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: IPFS_path
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: project_id
      value: '{{env.BLOCKFROST_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: blockfrost-ipfs-pins-rest
    port: 8080
    description: REST adapter for Blockfrost.io ~ API Documentation — IPFS » Pins. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/ipfs/pin/add/{ipfs-path}
      name: ipfs-pin-add-ipfs-path
      description: REST surface for ipfs-pin-add-IPFS_path.
      operations:
      - method: POST
        name: post
        description: Blockfrost Pin an Object
        call: blockfrost-ipfs-pins.post
        with:
          IPFS_path: rest.IPFS_path
          filecoin: rest.filecoin
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ipfs/pin/list
      name: ipfs-pin-list
      description: REST surface for ipfs-pin-list.
      operations:
      - method: GET
        name: get
        description: Blockfrost List Pinned Objects
        call: blockfrost-ipfs-pins.get
        with:
          count: rest.count
          page: rest.page
          order: rest.order
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ipfs/pin/list/{ipfs-path}
      name: ipfs-pin-list-ipfs-path
      description: REST surface for ipfs-pin-list-IPFS_path.
      operations:
      - method: GET
        name: get
        description: Blockfrost Get Details About Pinned Object
        call: blockfrost-ipfs-pins.get
        with:
          IPFS_path: rest.IPFS_path
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ipfs/pin/remove/{ipfs-path}
      name: ipfs-pin-remove-ipfs-path
      description: REST surface for ipfs-pin-remove-IPFS_path.
      operations:
      - method: POST
        name: post
        description: Blockfrost Remove a IPFS Pin
        call: blockfrost-ipfs-pins.post
        with:
          IPFS_path: rest.IPFS_path
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: blockfrost-ipfs-pins-mcp
    port: 9090
    transport: http
    description: MCP adapter for Blockfrost.io ~ API Documentation — IPFS » Pins. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: blockfrost-pin-object
      description: Blockfrost Pin an Object
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: blockfrost-ipfs-pins.post
      with:
        IPFS_path: tools.IPFS_path
        filecoin: tools.filecoin
      outputParameters:
      - type: object
        mapping: $.
    - name: blockfrost-list-pinned-objects
      description: Blockfrost List Pinned Objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: blockfrost-ipfs-pins.get
      with:
        count: tools.count
        page: tools.page
        order: tools.order
      outputParameters:
      - type: object
        mapping: $.
    - name: blockfrost-get-details-about-pinned
      description: Blockfrost Get Details About Pinned Object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: blockfrost-ipfs-pins.get
      with:
        IPFS_path: tools.IPFS_path
      outputParameters:
      - type: object
        mapping: $.
    - name: blockfrost-remove-ipfs-pin
      description: Blockfrost Remove a IPFS Pin
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: blockfrost-ipfs-pins.post
      with:
        IPFS_path: tools.IPFS_path
      outputParameters:
      - type: object
        mapping: $.