x402.cids.remove

Pinata SDK x402.cids.remove detaches a private IPFS CID from an x402 payment instruction so it no longer requires payment to access.

Remove a CID association from a payment instruction

Usage

import { PinataSDK } from "pinata";

const pinata = new PinataSDK({
  pinataJwt: process.env.PINATA_JWT!,
  pinataGateway: "example-gateway.mypinata.cloud",
});

const result = await pinata.x402.removeCid(
  "01234567-89ab-cdef-0123-456789abcdef",
  "bafkreih5aznjvttude6c3wbvqeebb6rlx5wkbzyppv7garjiubll2ceym4"
);

Returns

type CidRemoveResponse = {
  data: {};
};

Parameters

paymentInstructionId (required)

• Type: string

The unique identifier of the payment instruction

const result = await pinata.x402.removeCid(
  "01234567-89ab-cdef-0123-456789abcdef",
  "bafkreih5aznjvttude6c3wbvqeebb6rlx5wkbzyppv7garjiubll2ceym4"
);

cid (required)

• Type: string

The IPFS CID to remove from the payment instruction. Once removed, the content will no longer require payment for access through this instruction.

const result = await pinata.x402.removeCid(
  "01234567-89ab-cdef-0123-456789abcdef",
  "bafkreih5aznjvttude6c3wbvqeebb6rlx5wkbzyppv7garjiubll2ceym4"
);