Visit the Pinata API Keys page to generate new keys.In the ‘New Key’ modal, you can choose if you want the key to be an Admin key and have full access over every endpoint, or scope the keys by selecting which endpoints you want to use. You can also give it a limited number of uses, so be sure to give it a name to keep track of it. Once you have that filled out, click “Generate API Key” and it will show you the pinata_api_key, pinata_api_secret_key, and the JWT. It’s best to click “Copy All” and keep the API key data safe and secure.
Once API keys have been created, you will not be able to see the secret or JWT
again
Once you have created your keys you can go ahead and try testing them! Try to paste this into your terminal with your JWT
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pinata Docs","colors":{"primary":"#6D6FEB","light":"#5F61EA","dark":"#6D6FEB"},"logo":{"light":"https://mintcdn.com/pinata/1l40stvCFLGKMlbm/logo/light.svg?fit=max\u0026auto=format\u0026n=1l40stvCFLGKMlbm\u0026q=85\u0026s=305c1e8c782e670f10185c0147934643","dark":"https://mintcdn.com/pinata/1l40stvCFLGKMlbm/logo/dark.svg?fit=max\u0026auto=format\u0026n=1l40stvCFLGKMlbm\u0026q=85\u0026s=62b38d97fa820e178051e8ba53f99437"},"favicon":"https://mintcdn.com/pinata/1l40stvCFLGKMlbm/favicon.svg?fit=max\u0026auto=format\u0026n=1l40stvCFLGKMlbm\u0026q=85\u0026s=86bac205666df16404c7e44843af91ff","background":{"color":{"light":"#FFFFFF","dark":"#16141F"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Pinata App","href":"https://app.pinata.cloud"}},"footer":{"socials":{"website":"https://warpcast.com/~/channel/pinata","twitter":"https://twitter.com/pinatacloud","github":"https://github.com/PinataCloud","linkedin":"https://www.linkedin.com/company/pinatacloud"}},"seo":{"metatags":{"og:image":"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm","twitter:image":"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm","theme-color":"#16141F"},"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-5RMPXG14TE"}},"contextual":{"options":["claude","chatgpt","copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Keys","icon":"key-skeleton-left-right","href":"https://app.pinata.cloud/developers/api-keys"},{"anchor":"Blog","icon":"newspaper","href":"https://pinata.cloud/blog"},{"anchor":"Community","icon":"github","href":"https://github.com/PinataCloud"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pinata","hasAudioNarration":false,"actualSubdomain":"pinata","customDomains":["docs.pinata.cloud"],"gitSource":{"type":"github","owner":"pinatacloud","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a86027794d0a93be0677abb","collectionId":"4ca7b389-1103-4244-8cb5-2c6a687bb39a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a86027794d0a93be0677abb"},"feedback":{"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a86027794d0a93be0677abb:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"SDK","count":83},{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"Documentation","count":79},{"language":"default","tag":"Files","count":48},{"language":"default","tag":"Gateways","count":32},{"language":"default","tag":"AI","count":29},{"language":"default","tag":"Groups","count":28},{"language":"default","tag":"private","count":26},{"language":"default","tag":"public","count":26},{"language":"default","tag":"x402 Monetization","count":21}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"Getting started with the Pinata API","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Getting started with the Pinata API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,OptimizedImage,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome to the Pinata API Reference! Before you can do anything in the API, you’ll need some API Keys.`}),`\n`,_jsx(Heading,{level:`2`,id:`api-keys`,children:`API Keys`}),`\n`,_jsxs(_components.p,{children:[`Visit the `,_jsx(_components.a,{href:`https://app.pinata.cloud/developers/api-keys`,children:`Pinata API Keys`}),` page to generate new keys.`]}),`\n`,_jsx(OptimizedImage,{style:{width:`100%`,borderRadius:`0.5rem`},src:`https://docs.mypinata.cloud/ipfs/bafybeignh2yy7bp7qpts5vi46prbjd6lbz23lmtbfcgvpcwc5rjkudrfta`}),`\n`,_jsxs(_components.p,{children:[`In the ‘New Key’ modal, you can choose if you want the key to be an Admin key and have full access over every endpoint, or scope the keys by selecting which endpoints you want to use. You can also give it a limited number of uses, so be sure to give it a name to keep track of it. Once you have that filled out, click “Generate API Key” and it will show you the `,_jsx(_components.code,{children:`pinata_api_key`}),`, `,_jsx(_components.code,{children:`pinata_api_secret_key`}),`, and the `,_jsx(_components.code,{children:`JWT`}),`. It’s best to click “Copy All” and keep the API key data safe and secure.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Once API keys have been created, you will not be able to see the secret or JWT\nagain`})}),`\n`,_jsxs(_components.p,{children:[`Once you have created your keys you can go ahead and try testing them! Try to paste this into your terminal with your `,_jsx(_components.code,{children:`JWT`})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.pinata.cloud/data/testAuthentication`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'accept: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'authorization: Bearer YOUR_PINATA_JWT'`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`If successful you should see this!`}),`\n`,_jsx(CodeBlock,{filename:`bash`,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Congratulations! You are communicating with the Pinata API!\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Getting started with the Pinata API","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API Keys","slug":"api-keys","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/pinata/0188189cb1e45a94/reo.js"],"subdomain":"pinata","siteName":"Pinata Docs","title":"Introduction - Pinata Docs","navMaps":{"firstHrefInVersion":{"v3":{"href":"/api-reference/introduction","matchLevel":0},"legacy":{"href":"/api-reference/introduction","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-26T16:39:22.880Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Getting started with the Pinata API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pinata Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Pinata Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Getting started with the Pinata API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pinata Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pinata.cloud/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Pinata Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Getting started with the Pinata API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/pinata/819z3Ds6hhZIH97L/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pinata Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6D6FEB\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#16141F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pinata.cloud/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pinata.cloud/#organization\",\"name\":\"Pinata Docs\",\"url\":\"https://docs.pinata.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pinata/1l40stvCFLGKMlbm/logo/light.svg?fit=max\u0026auto=format\u0026n=1l40stvCFLGKMlbm\u0026q=85\u0026s=305c1e8c782e670f10185c0147934643\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pinata.cloud#website\",\"name\":\"Pinata Docs\",\"url\":\"https://docs.pinata.cloud\",\"publisher\":{\"@id\":\"https://docs.pinata.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pinata.cloud/api-reference/introduction#webpage\",\"url\":\"https://docs.pinata.cloud/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"Getting started with the Pinata API\",\"dateModified\":\"2026-01-26T16:39:22.880Z\",\"isPartOf\":{\"@id\":\"https://docs.pinata.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinata.cloud/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinata.cloud/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pinata Docs\",\"item\":\"https://docs.pinata.cloud\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.pinata.cloud/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.pinata.cloud/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Getting started with the Pinata API\",\"url\":\"https://docs.pinata.cloud/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinata.cloud/api-reference/introduction#webpage\"},\"image\":\"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm\",\"dateModified\":\"2026-01-26T16:39:22.880Z\",\"publisher\":{\"@id\":\"https://docs.pinata.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pinata.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pinata Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pinata Docs","nav":{"global":{"anchors":[{"anchor":"API Keys","icon":"key-skeleton-left-right","href":"https://app.pinata.cloud/developers/api-keys"},{"anchor":"Blog","icon":"newspaper","href":"https://pinata.cloud/blog"},{"anchor":"Community","icon":"github","href":"https://github.com/PinataCloud"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/quickstart"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/getting-started"}]},{"tab":"API Reference","versions":[{"version":"v3","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Uploads","pages":[{"openapi":"post /files","title":"Upload a File","description":"`org:files:write`\n","href":"/api-reference/endpoint/upload-a-file"},{"title":"Create Signed Upload URL","openapi":"pinata-api-v3-uploads.yaml post /files/sign","href":"/api-reference/endpoint/create-signed-upload-url"}]},{"group":"Files","pages":[{"openapi":"get /files/{network}","title":"List Files","href":"/api-reference/endpoint/list-files"},{"openapi":"get /files/{network}/{id}","title":"Get File by ID","href":"/api-reference/endpoint/get-file-by-id"},{"title":"Create Download Link","openapi":"pinata-api-v3.yaml post /files/private/download_link","href":"/api-reference/endpoint/get-signed-url"},{"openapi":"put /files/{network}/{id}","title":"Update File","href":"/api-reference/endpoint/update-file"},{"openapi":"delete /files/{network}/{id}","title":"Delete File by ID","href":"/api-reference/endpoint/delete-file-by-id"},{"openapi":"post /vectorize/files/{file_id}","title":"Vectorize a File","href":"/api-reference/endpoint/vectorize-file"},{"openapi":"post /vectorize/groups/{group_id}/query","title":"Query File Vectors","href":"/api-reference/endpoint/query-file-vectors"},{"openapi":"delete /vectorize/files/{file_id}","title":"Delete File Vectors","href":"/api-reference/endpoint/delete-file-vectors"}]},{"group":"Groups","pages":[{"openapi":"post /groups/{network}","title":"Create Group","href":"/api-reference/endpoint/create-group"},{"openapi":"get /groups/{network}/{id}","title":"Get Group","href":"/api-reference/endpoint/get-group"},{"openapi":"get /groups/{network}","title":"List Groups","href":"/api-reference/endpoint/list-groups"},{"openapi":"put /groups/{network}/{id}/ids/{file_id}","title":"Add File To Group","href":"/api-reference/endpoint/add-file-to-group"},{"openapi":"delete /groups/{network}/{id}/ids/{file_id}","title":"Remove File From Group","href":"/api-reference/endpoint/remove-file-from-group"},{"openapi":"put /groups/{network}/{id}","title":"Update Group","href":"/api-reference/endpoint/update-group"},{"openapi":"delete /groups/{network}/{id}","title":"Delete Group","href":"/api-reference/endpoint/delete-group"}]},{"group":"Pin by CID","pages":[{"openapi":"post /files/public/pin_by_cid","title":"Pin by CID","href":"/api-reference/endpoint/pin-by-cid"},{"openapi":"get /files/public/pin_by_cid","title":"Query Pin Requests","href":"/api-reference/endpoint/query-pin-requests"},{"openapi":"DELETE /files/public/pin_by_cid/{id}","title":"Cancel Request","href":"/api-reference/endpoint/cancel-pin-by-cid"}]},{"group":"Swaps","pages":[{"openapi":"put /files/{network}/swap/{cid}","title":"Add Swap","href":"/api-reference/endpoint/add-swap"},{"openapi":"get /files/{network}/swap/{cid}","title":"Get Swap History","href":"/api-reference/endpoint/get-swap-history"},{"openapi":"delete /files/{network}/swap/{cid}","title":"Remove Swap","href":"/api-reference/endpoint/remove-swap"}]},{"group":"API Keys","pages":[{"openapi":"post /api_keys","title":"Create API Key","href":"/api-reference/endpoint/v3-create-api-key"},{"openapi":"get /api_keys","title":"List API Keys","href":"/api-reference/endpoint/v3-list-api-keys"},{"openapi":"delete /api_keys/{key}","title":"Revoke API Key","href":"/api-reference/endpoint/v3-revoke-api-key"}]},{"group":"Signatures","pages":[{"openapi":"get /files/{network}/signature/{cid}","title":"Get Signature for a CID","href":"/api-reference/endpoint/get-signature-for-a-cid"},{"openapi":"post /files/{network}/signature/{cid}","title":"Add Signature to CId","href":"/api-reference/endpoint/add-signature-to-cid"},{"openapi":"delete /files/{network}/signature/{cid}","title":"Remove Signature from CID","href":"/api-reference/endpoint/remove-signature-from-cid"}]},{"group":"Gateways","pages":[{"group":"General","pages":[{"openapi":"get /gateways","title":"List Gateways","href":"/api-reference/endpoint/ipfs/list-gateways"},{"openapi":"get /gateways/{id}","title":"Gateway Details","href":"/api-reference/endpoint/ipfs/gateway-details"},{"openapi":"get /gateways/exists/{domain}","title":"Gateway Domain Available","href":"/api-reference/endpoint/ipfs/gateway-domain-available"},{"openapi":"post /gateways","title":"Create Gateway","href":"/api-reference/endpoint/ipfs/create-gateway"},{"openapi":"delete /gateways/{id}","title":"Delete Gateway","href":"/api-reference/endpoint/ipfs/delete-gateway"}]},{"group":"Custom Domains","pages":[{"openapi":"get /gateways/{id}/custom_domain/{custom_domain_id}","title":"Gateway Custom Domain Details","href":"/api-reference/endpoint/ipfs/gateway-custom-domain-details"},{"openapi":"post /gateways/{id}/custom_domain","title":"Create Custom Domain for Gateway","href":"/api-reference/endpoint/ipfs/create-custom-domain-for-gateway"},{"openapi":"delete /gateways/{id}/custom_domain/{custom_domain_id}","title":"Delete Gateway Custom Domain","href":"/api-reference/endpoint/ipfs/delete-gateway-custom-domain"}]},{"group":"Access Controls","pages":[{"openapi":"post /gateways/{id}/access_tokens","title":"Create Gateway Key Restriction","href":"/api-reference/endpoint/ipfs/create-gateway-key-restriction"},{"openapi":"post /gateways/{id}/ips","title":"Create Gateway IP Address Restriction","href":"/api-reference/endpoint/ipfs/create-gateway-ip-address-restriction"},{"openapi":"post /gateways/{id}/hosts","title":"Create Gateway Host Origin Restriction","href":"/api-reference/endpoint/ipfs/create-gateway-host-origin-restriction"},{"openapi":"delete /gateways/{id}/access_tokens/{access_token_id}","title":"Revoke Gateway Key","href":"/api-reference/endpoint/ipfs/revoke-gateway-key"},{"openapi":"delete /gateways/{id}/ips/{ip_id}","title":"Revoke IP Address Restricton","href":"/api-reference/endpoint/ipfs/revoke-ip-address-restricton"},{"openapi":"delete /gateways/{id}/hosts/{host_id}","title":"Revoke Host Origin Restriction","href":"/api-reference/endpoint/ipfs/revoke-host-origin-restriction"}]},{"group":"Gateway Analytics","pages":[{"openapi":"get /analytics/gateways/top","title":"Top Gateway Analytics","href":"/api-reference/endpoint/ipfs/top-gateway-analytics"},{"openapi":"get /analytics/gateways/time_series","title":"Time Interval Gateway Analytics","href":"/api-reference/endpoint/ipfs/time-interval-gateway-analytics"}]},{"group":"Gateway Plugins","pages":[{"openapi":"get /gateways/plugins/marketplace","title":"List Marketplace Plugins","href":"/api-reference/endpoint/ipfs/list-marketplace-plugins"},{"openapi":"get /gateways/plugins/marketplace/{id}","title":"Get Marketplace Plugin Details","href":"/api-reference/endpoint/ipfs/get-marketplace-plugin-details"},{"openapi":"get /ipfs/gateway_plugins/{gateway_id}","title":"List Installed Plugins for Gateway","href":"/api-reference/endpoint/ipfs/list-installed-plugins-for-gateway"},{"openapi":"post /gateways/plugins/{gateway_id}","title":"Install Gateway Plugin","href":"/api-reference/endpoint/ipfs/install-gateway-plugin"},{"openapi":"get /gateways/plugins","title":"List Gateway Plugins","href":"/api-reference/endpoint/ipfs/list-gateway-plugins"},{"openapi":"delete /gateways/plugins/{gateway_id}/plugin/{plugin_id}","title":"Uninstall Gateway Plugin","href":"/api-reference/endpoint/ipfs/uninstall-gateway-plugin"}]}]},{"group":"x402","pages":[{"group":"x402 Monetization","pages":[{"group":"Payment Instructions","pages":[{"openapi":"get /x402/payment_instructions","title":"List Payment Instructions","href":"/api-reference/endpoint/x402/payment-instructions-list"},{"openapi":"post /x402/payment_instructions","title":"Create Payment Instruction","href":"/api-reference/endpoint/x402/payment-instructions-create"},{"openapi":"get /x402/payment_instructions/{id}","title":"Get Payment Instruction","href":"/api-reference/endpoint/x402/payment-instructions-get"},{"openapi":"patch /x402/payment_instructions/{id}","title":"Update Payment Instruction","href":"/api-reference/endpoint/x402/payment-instructions-update"},{"openapi":"delete /x402/payment_instructions/{id}","title":"Delete Payment Instruction","href":"/api-reference/endpoint/x402/payment-instructions-delete"}]},{"group":"CID Management","pages":[{"openapi":"get /x402/payment_instructions/{id}/cids","title":"List CIDs for Payment Instruction","href":"/api-reference/endpoint/x402/cids-list"},{"openapi":"put /x402/payment_instructions/{id}/cids/{cid}","title":"Add CID to Payment Instruction","href":"/api-reference/endpoint/x402/cids-add"},{"openapi":"delete /x402/payment_instructions/{id}/cids/{cid}","title":"Remove CID from Payment Instruction","href":"/api-reference/endpoint/x402/cids-remove"}]}]},{"group":"x402 Services","pages":[{"title":"Upload a File","openapi":"pinata-x402-api-v1.yaml post /pin/{network}","href":"/api-reference/endpoint/x402/pin"},{"title":"Retrieve a Private File","openapi":"pinata-x402-api-v1.yaml get /retrieve/private/{cid}","description":"Retrieves a private file from IPFS by its CID","href":"/api-reference/endpoint/x402/retrieve"}]}]}]},{"version":"legacy","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Authentication","pages":[{"openapi":"get /data/testAuthentication","title":"Test Authentication","description":"Test your API keys and your ability to connect to the Pinata API","href":"/api-reference/endpoint/ipfs/test-authentication"}]},{"group":"Pinning","pages":[{"openapi":"post /pinning/pinFileToIPFS","title":"Pin File to IPFS","href":"/api-reference/endpoint/ipfs/pin-file-to-ipfs"},{"openapi":"post /pinning/pinJSONToIPFS","title":"Pin JSON","href":"/api-reference/endpoint/ipfs/pin-json-to-ipfs"},{"openapi":"get /data/pinList","title":"List Files","href":"/api-reference/endpoint/ipfs/list-files"},{"openapi":"put /pinning/hashMetadata","title":"Update File Metadata","href":"/api-reference/endpoint/ipfs/update-file-metadata"},{"openapi":"delete /pinning/unpin/{CID}","title":"Delete File (Unpin)","href":"/api-reference/endpoint/ipfs/unpin-file"}]},{"group":"Groups","pages":[{"openapi":"post /groups","title":"Create Group","href":"/api-reference/endpoint/ipfs/create-group"},{"openapi":"get /groups/{id}","title":"Get a Group","href":"/api-reference/endpoint/ipfs/get-a-group"},{"openapi":"get /groups","title":"List Groups","href":"/api-reference/endpoint/ipfs/list-groups"},{"openapi":"put /groups/{id}","title":"Update Group","href":"/api-reference/endpoint/ipfs/update-group"},{"openapi":"put /groups/{id}/cids","title":"Add CIDs to Group","href":"/api-reference/endpoint/ipfs/add-cids-to-group"},{"openapi":"delete /groups/{id}/cids","title":"Remove CIDs from a Group","href":"/api-reference/endpoint/ipfs/remove-cids-from-a-group"},{"openapi":"delete /groups/{id}","title":"Delete Group","href":"/api-reference/endpoint/ipfs/delete-group"}]},{"group":"Pinning by CID","pages":[{"openapi":"post /pinning/pinByHash","title":"Pin By CID","href":"/api-reference/endpoint/ipfs/pin-by-cid"},{"openapi":"get /pinning/pinJobs","title":"List Pin By CID Jobs","href":"/api-reference/endpoint/ipfs/list-pin-by-cid-jobs"},{"title":"Pinning Service API","href":"/api-reference/pinning-service-api"}]},{"group":"Keys","pages":[{"openapi":"post /users/generateApiKey","title":"Generate Pinata API Key","href":"/api-reference/endpoint/ipfs/generate-pinata-api-key"},{"openapi":"get /users/apiKeys","title":"List API Keys","href":"/api-reference/endpoint/ipfs/list-api-keys"},{"openapi":"put /users/revokeApiKey","title":"Revoke API Key","href":"/api-reference/endpoint/ipfs/revoke-api-key"}]}]}]}]},"basePath":"","title":"Introduction - Pinata Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-eHyQ0tlO.js","lightbox-handle-r17bVUz3.js"]}