# Pinata Docs ## Docs - [API Keys](https://docs.pinata.cloud/account-management/api-keys.md) - [Billing](https://docs.pinata.cloud/account-management/billing.md) - [Limits](https://docs.pinata.cloud/account-management/limits.md) - [Webhooks](https://docs.pinata.cloud/account-management/webhooks.md): Subscribe to Pinata API events using Webhooks - [Workspaces](https://docs.pinata.cloud/account-management/workspaces.md) - [Add File To Group](https://docs.pinata.cloud/api-reference/endpoint/add-file-to-group.md): `org:groups:write` - [Add Signature to CId](https://docs.pinata.cloud/api-reference/endpoint/add-signature-to-cid.md): `org:files:write` - [Add Swap](https://docs.pinata.cloud/api-reference/endpoint/add-swap.md): `org:files:write` - [Cancel Request](https://docs.pinata.cloud/api-reference/endpoint/cancel-pin-by-cid.md): `org:files:write` - [Create Group](https://docs.pinata.cloud/api-reference/endpoint/create-group.md): `org:groups:write` - [Create Signed Upload URL](https://docs.pinata.cloud/api-reference/endpoint/create-signed-upload-url.md): `org:files:write` - [Delete File by ID](https://docs.pinata.cloud/api-reference/endpoint/delete-file-by-id.md): `org:files:write` - [Delete File Vectors](https://docs.pinata.cloud/api-reference/endpoint/delete-file-vectors.md): `org:write` - [Delete Group](https://docs.pinata.cloud/api-reference/endpoint/delete-group.md): `org:groups:write` - [Get File by ID](https://docs.pinata.cloud/api-reference/endpoint/get-file-by-id.md): `org:files:read` - [Get Group](https://docs.pinata.cloud/api-reference/endpoint/get-group.md): `org:groups:read` - [Get Signature for a CID](https://docs.pinata.cloud/api-reference/endpoint/get-signature-for-a-cid.md): `org:files:read` - [Create Download Link](https://docs.pinata.cloud/api-reference/endpoint/get-signed-url.md): `org:files:write` - [Get Swap History](https://docs.pinata.cloud/api-reference/endpoint/get-swap-history.md): `org:files:read` - [Create Custom Domain for Gateway](https://docs.pinata.cloud/api-reference/endpoint/ipfs/create-custom-domain-for-gateway.md): `org:gateways:write` - [Create Gateway](https://docs.pinata.cloud/api-reference/endpoint/ipfs/create-gateway.md): `org:gateways:write` - [Create Gateway Host Origin Restriction](https://docs.pinata.cloud/api-reference/endpoint/ipfs/create-gateway-host-origin-restriction.md): `org:gateways:write` - [Create Gateway IP Address Restriction](https://docs.pinata.cloud/api-reference/endpoint/ipfs/create-gateway-ip-address-restriction.md): `org:gateways:write` - [Create Gateway Key Restriction](https://docs.pinata.cloud/api-reference/endpoint/ipfs/create-gateway-key-restriction.md): `org:gateways:write` - [Delete Gateway](https://docs.pinata.cloud/api-reference/endpoint/ipfs/delete-gateway.md): `org:gateways:write` - [Delete Gateway Custom Domain](https://docs.pinata.cloud/api-reference/endpoint/ipfs/delete-gateway-custom-domain.md): `org:gateways:write` - [Gateway Custom Domain Details](https://docs.pinata.cloud/api-reference/endpoint/ipfs/gateway-custom-domain-details.md): `org:gateways:read` - [Gateway Details](https://docs.pinata.cloud/api-reference/endpoint/ipfs/gateway-details.md): `org:gateways:read` - [Gateway Domain Available](https://docs.pinata.cloud/api-reference/endpoint/ipfs/gateway-domain-available.md): `org:gateways:read` - [Get Marketplace Plugin Details](https://docs.pinata.cloud/api-reference/endpoint/ipfs/get-marketplace-plugin-details.md): `org:gateways:read` - [Install Gateway Plugin](https://docs.pinata.cloud/api-reference/endpoint/ipfs/install-gateway-plugin.md): `org:gateways:write` - [List Gateway Plugins](https://docs.pinata.cloud/api-reference/endpoint/ipfs/list-gateway-plugins.md): `org:gateways:read` - [List Gateways](https://docs.pinata.cloud/api-reference/endpoint/ipfs/list-gateways.md): `org:gateways:read` - [null](https://docs.pinata.cloud/api-reference/endpoint/ipfs/list-installed-plugins-for-gateway.md) - [List Marketplace Plugins](https://docs.pinata.cloud/api-reference/endpoint/ipfs/list-marketplace-plugins.md): `org:gateways:read` - [Revoke Gateway Key](https://docs.pinata.cloud/api-reference/endpoint/ipfs/revoke-gateway-key.md): `org:gateways:write` - [Revoke Host Origin Restriction](https://docs.pinata.cloud/api-reference/endpoint/ipfs/revoke-host-origin-restriction.md): `org:gateways:write` - [Revoke IP Address Restricton](https://docs.pinata.cloud/api-reference/endpoint/ipfs/revoke-ip-address-restricton.md): `org:gateways:write: - [Time Interval Gateway Analytics](https://docs.pinata.cloud/api-reference/endpoint/ipfs/time-interval-gateway-analytics.md): `org:analytics:read` - [Top Gateway Analytics](https://docs.pinata.cloud/api-reference/endpoint/ipfs/top-gateway-analytics.md): `org:analytics:read` - [Uninstall Gateway Plugin](https://docs.pinata.cloud/api-reference/endpoint/ipfs/uninstall-gateway-plugin.md): `org:gateways:write` - [List Files](https://docs.pinata.cloud/api-reference/endpoint/list-files.md): `org:files:read` - [List Groups](https://docs.pinata.cloud/api-reference/endpoint/list-groups.md): `org:groups:read` - [Pin by CID](https://docs.pinata.cloud/api-reference/endpoint/pin-by-cid.md): `org:files:write` - [Query File Vectors](https://docs.pinata.cloud/api-reference/endpoint/query-file-vectors.md): `org:write` - [Query Pin Requests](https://docs.pinata.cloud/api-reference/endpoint/query-pin-requests.md): `org:files:read` - [Remove File From Group](https://docs.pinata.cloud/api-reference/endpoint/remove-file-from-group.md): `org:groups:write` - [Remove Signature from CID](https://docs.pinata.cloud/api-reference/endpoint/remove-signature-from-cid.md): `org:files:write` - [Remove Swap](https://docs.pinata.cloud/api-reference/endpoint/remove-swap.md): `org:files:write` - [Update File](https://docs.pinata.cloud/api-reference/endpoint/update-file.md): `org:files:write` - [Update Group](https://docs.pinata.cloud/api-reference/endpoint/update-group.md): `org:groups:write` - [Upload a File](https://docs.pinata.cloud/api-reference/endpoint/upload-a-file.md): `org:files:write` - [Create API Key](https://docs.pinata.cloud/api-reference/endpoint/v3-create-api-key.md): `org:write` - [List API Keys](https://docs.pinata.cloud/api-reference/endpoint/v3-list-api-keys.md): `org:write` - [Revoke API Key](https://docs.pinata.cloud/api-reference/endpoint/v3-revoke-api-key.md): `org:write` - [Vectorize a File](https://docs.pinata.cloud/api-reference/endpoint/vectorize-file.md): `org:write` - [Introduction](https://docs.pinata.cloud/api-reference/introduction.md): Getting started with the Pinata API - [Fetch all casts authored by an FID.](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/casts/fetch-all-casts-authored-by-an-fid.md) - [Fetch all casts by parent cast's FID and Hash OR by the parent's URL](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/casts/fetch-all-casts-by-parent-casts-fid-and-hash-or-by-the-parents-url.md) - [Fetch all casts that mention an FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/casts/fetch-all-casts-that-mention-an-fid.md) - [Get a cast by its FID and Hash.](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/casts/get-a-cast-by-its-fid-and-hash.md) - [Get a list of all the FIDs](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/fids/get-a-list-of-all-the-fids.md) - [Info](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/info/info.md) - [Get a link by its FID and target FID.](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/links/get-a-link-by-its-fid-and-target-fid.md) - [Get all links from a source FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/links/get-all-links-from-a-source-fid.md) - [Get all links to a target FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/links/get-all-links-to-a-target-fid.md) - [Get a list of on-chain events provided by an FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/onchainevents/get-a-list-of-on-chain-events-provided-by-an-fid.md) - [Get a list of signers provided by an FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/onchainevents/get-a-list-of-signers-provided-by-an-fid.md): **Note:** one of two different response schemas is returned based on whether the caller provides the `signer` parameter. If included, a single `OnChainEventSigner` message is returned (or a `not_found` error). If omitted, a non-paginated list of `OnChainEventSigner` messages is returned instead - [Get an on chain ID Registry Event for a given Address](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/onchainevents/get-an-on-chain-id-registry-event-for-a-given-address.md) - [Get a reaction by its created FID and target Cast.](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/reactions/get-a-reaction-by-its-created-fid-and-target-cast.md) - [Get all reactions by an FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/reactions/get-all-reactions-by-an-fid.md) - [Get all reactions to a cast](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/reactions/get-all-reactions-to-a-cast.md) - [Get all reactions to a target URL](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/reactions/get-all-reactions-to-a-target-url.md) - [Get an FID's storage limits.](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/storage/get-an-fids-storage-limits.md) - [Get UserData for a FID.](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/userdata/get-userdata-for-a-fid.md): **Note:** one of two different response schemas is returned based on whether the caller provides the `user_data_type` parameter. If included, a single `UserDataAdd` message is returned (or a `not_found` error). If omitted, a paginated list of `UserDataAdd` messages is returned instead - [Get a list of proofs provided by an FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/usernames/get-a-list-of-proofs-provided-by-an-fid.md) - [Get an proof for a username by the Farcaster username](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/usernames/get-an-proof-for-a-username-by-the-farcaster-username.md) - [Get a list of verifications provided by an FID](https://docs.pinata.cloud/farcaster/hub-api-reference/endpoint/verifications/get-a-list-of-verifications-provided-by-an-fid.md) - [Hubs](https://docs.pinata.cloud/farcaster/hubs.md) - [Introduction](https://docs.pinata.cloud/farcaster/introduction.md) - [Deleting Files](https://docs.pinata.cloud/files/deleting-files.md) - [Groups](https://docs.pinata.cloud/files/file-groups.md) - [Key-Values](https://docs.pinata.cloud/files/key-values.md) - [List & Query Files](https://docs.pinata.cloud/files/listing-files.md) - [Presigned URLs](https://docs.pinata.cloud/files/presigned-urls.md) - [Private IPFS](https://docs.pinata.cloud/files/private-ipfs.md) - [Signatures](https://docs.pinata.cloud/files/signatures.md): Learn how to use Pinata to cryptographically sign CIDs - [Uploading Files](https://docs.pinata.cloud/files/uploading-files.md) - [File Vectors (Beta)](https://docs.pinata.cloud/files/vectors.md) - [Astro](https://docs.pinata.cloud/frameworks/astro.md): Get started using Pinata with Astro - [Hono](https://docs.pinata.cloud/frameworks/hono.md) - [Next.js](https://docs.pinata.cloud/frameworks/next-js.md): Get started using Pinata with Next.js - [Node.js](https://docs.pinata.cloud/frameworks/node-js.md) - [React](https://docs.pinata.cloud/frameworks/react.md) - [Remix](https://docs.pinata.cloud/frameworks/remix.md): Get started using Pinata with Remix - [SvelteKit](https://docs.pinata.cloud/frameworks/sveltekit.md) - [Dedicated IPFS Gateways](https://docs.pinata.cloud/gateways/dedicated-ipfs-gateways.md) - [Gateway Access Controls](https://docs.pinata.cloud/gateways/gateway-access-controls.md) - [Image Optimizations](https://docs.pinata.cloud/gateways/image-optimizations.md) - [Content Addressable](https://docs.pinata.cloud/gateways/plugins/content-addressable.md): Use the Content Addressable plugin to include CID signatures - [Getting Started](https://docs.pinata.cloud/gateways/plugins/getting-started.md): Learn how to use Dedicated Gateway plugins to supercharge your IPFS delivery system - [Hot Swaps](https://docs.pinata.cloud/gateways/plugins/hot-swaps.md): Use the Hot Swaps plugin to make one CID map to another - [Retrieving Files](https://docs.pinata.cloud/gateways/retrieving-files.md) - [How does IPFS work with NFTs?](https://docs.pinata.cloud/ipfs-101/how-does-ipfs-work-with-nfts.md) - [What are CIDs?](https://docs.pinata.cloud/ipfs-101/what-are-cids.md) - [What are IPFS Gateways?](https://docs.pinata.cloud/ipfs-101/what-are-ipfs-gateways.md) - [What is IPFS?](https://docs.pinata.cloud/ipfs-101/what-is-ipfs.md) - [What is Pinning?](https://docs.pinata.cloud/ipfs-101/what-is-ipfs-pinning.md) - [LLM Docs](https://docs.pinata.cloud/llm-docs.md) - [Quickstart](https://docs.pinata.cloud/quickstart.md): Start uploading and retrieving content in no time - [bandwidth](https://docs.pinata.cloud/sdk/analytics/bandwidth.md) - [requests](https://docs.pinata.cloud/sdk/analytics/requests.md) - [Config](https://docs.pinata.cloud/sdk/config.md) - [addSwap](https://docs.pinata.cloud/sdk/files/private/add-swap.md) - [delete](https://docs.pinata.cloud/sdk/files/private/delete.md) - [deleteSwap](https://docs.pinata.cloud/sdk/files/private/delete-swap.md) - [deleteVectors](https://docs.pinata.cloud/sdk/files/private/delete-vectors.md) - [getSwapHistory](https://docs.pinata.cloud/sdk/files/private/get-swap-history.md) - [list](https://docs.pinata.cloud/sdk/files/private/list.md) - [queryVectors](https://docs.pinata.cloud/sdk/files/private/query-vectors.md) - [update](https://docs.pinata.cloud/sdk/files/private/update.md) - [vectorize](https://docs.pinata.cloud/sdk/files/private/vectorize.md) - [addSwap](https://docs.pinata.cloud/sdk/files/public/add-swap.md) - [delete](https://docs.pinata.cloud/sdk/files/public/delete.md) - [deleteSwap](https://docs.pinata.cloud/sdk/files/public/delete-swap.md) - [getSwapHistory](https://docs.pinata.cloud/sdk/files/public/get-swap-history.md) - [list](https://docs.pinata.cloud/sdk/files/public/list.md) - [queue](https://docs.pinata.cloud/sdk/files/public/queue.md) - [update](https://docs.pinata.cloud/sdk/files/public/update.md) - [createAccessLink](https://docs.pinata.cloud/sdk/gateways/private/create-signed-url.md) - [get](https://docs.pinata.cloud/sdk/gateways/private/get.md) - [convert](https://docs.pinata.cloud/sdk/gateways/public/convert.md) - [get](https://docs.pinata.cloud/sdk/gateways/public/get.md) - [Getting Started](https://docs.pinata.cloud/sdk/getting-started.md): Get up and running with the Pinata IPFS SDK - [addFiles](https://docs.pinata.cloud/sdk/groups/private/add-files.md) - [create](https://docs.pinata.cloud/sdk/groups/private/create.md) - [delete](https://docs.pinata.cloud/sdk/groups/private/delete.md) - [get](https://docs.pinata.cloud/sdk/groups/private/get.md) - [list](https://docs.pinata.cloud/sdk/groups/private/list.md) - [removeFiles](https://docs.pinata.cloud/sdk/groups/private/remove-files.md) - [update](https://docs.pinata.cloud/sdk/groups/private/update.md) - [addFiles](https://docs.pinata.cloud/sdk/groups/public/add-files.md) - [create](https://docs.pinata.cloud/sdk/groups/public/create.md) - [delete](https://docs.pinata.cloud/sdk/groups/public/delete.md) - [get](https://docs.pinata.cloud/sdk/groups/public/get.md) - [list](https://docs.pinata.cloud/sdk/groups/public/list.md) - [removeFiles](https://docs.pinata.cloud/sdk/groups/public/remove-files.md) - [update](https://docs.pinata.cloud/sdk/groups/public/update.md) - [create](https://docs.pinata.cloud/sdk/keys/create.md) - [list](https://docs.pinata.cloud/sdk/keys/list.md) - [revoke](https://docs.pinata.cloud/sdk/keys/revoke.md) - [add](https://docs.pinata.cloud/sdk/signatures/private/add.md) - [delete](https://docs.pinata.cloud/sdk/signatures/private/delete.md) - [get](https://docs.pinata.cloud/sdk/signatures/private/get.md) - [add](https://docs.pinata.cloud/sdk/signatures/public/add.md) - [delete](https://docs.pinata.cloud/sdk/signatures/public/delete.md) - [get](https://docs.pinata.cloud/sdk/signatures/public/get.md) - [testAuthenticaiton](https://docs.pinata.cloud/sdk/test-authentication.md) - [Analytics](https://docs.pinata.cloud/sdk/types/analytics.md) - [Config](https://docs.pinata.cloud/sdk/types/config.md) - [Files](https://docs.pinata.cloud/sdk/types/files.md) - [Gateways](https://docs.pinata.cloud/sdk/types/gateways.md) - [Groups](https://docs.pinata.cloud/sdk/types/groups.md) - [Keys](https://docs.pinata.cloud/sdk/types/keys.md) - [Signatures](https://docs.pinata.cloud/sdk/types/signatures.md) - [Uploads](https://docs.pinata.cloud/sdk/types/uploads.md) - [base64](https://docs.pinata.cloud/sdk/upload/private/base64.md) - [createSignedURL](https://docs.pinata.cloud/sdk/upload/private/create-signed-url.md) - [file](https://docs.pinata.cloud/sdk/upload/private/file.md) - [json](https://docs.pinata.cloud/sdk/upload/private/json.md) - [url](https://docs.pinata.cloud/sdk/upload/private/url.md) - [base64](https://docs.pinata.cloud/sdk/upload/public/base64.md) - [cid](https://docs.pinata.cloud/sdk/upload/public/cid.md) - [createSignedURL](https://docs.pinata.cloud/sdk/upload/public/create-signed-url.md) - [file](https://docs.pinata.cloud/sdk/upload/public/file.md) - [fileArray](https://docs.pinata.cloud/sdk/upload/public/file-array.md) - [json](https://docs.pinata.cloud/sdk/upload/public/json.md) - [url](https://docs.pinata.cloud/sdk/upload/public/url.md) - [V2 Migration Guide](https://docs.pinata.cloud/sdk/v2-migration-guide.md) - [Community SDKs](https://docs.pinata.cloud/tools/community-sdks.md) - [IPFS CLI](https://docs.pinata.cloud/tools/ipfs-cli.md): The official CLI for Pinata written in Go ## Optional - [API Keys](https://app.pinata.cloud/developers/api-keys) - [Blog](https://pinata.cloud/blog) - [Community](https://github.com/PinataCloud)