Run LLM inference on Pinata with an OpenAI-compatible API
Pinata Inference is a hosted, OpenAI-compatible LLM endpoint. Enable it on your account, then use it two ways:
API — point any OpenAI-compatible client at Pinata and call chat completions directly, no agent required.
Agents app — the same hosted models show up alongside your other providers in an agent’s Models list (connect the Pinata provider in the Secrets Vault).
Either way, requests run against the models Pinata hosts, and usage is metered and drawn down from your credit balance.
Inference is billed through credits. Before your first request, make sure your workspace has a credit balance and (optionally) auto top-up enabled so requests don’t fail on an empty balance.
Enabling generates an Ed25519 key pair: the private key is returned once in this response and also stored encrypted in your secrets as PINATA_LLM_KEY; the public key is kept for request validation.
The privateKey is your inference credential — it’s what authenticates chat completions, not your Pinata JWT. Save it now; it isn’t returned again.
Prefer the dashboard? Connecting the Pinata provider in the Secrets Vault does the same thing, and is also how Pinata-hosted models become selectable inside your agents.
Disabling revokes the inference key and removes the associated secrets. New requests to the chat completions endpoint are rejected and Pinata-hosted models are no longer selectable in agents — any running agents using the managed key are automatically flipped to the free tier fallback so they don’t break. Your credit balance is untouched — disabling does not refund or expire credits — and you can re-enable at any time (which mints a newprivateKey).
Disabling takes effect immediately. Any in-flight requests may be cut off, and anything pointing at the endpoint will start getting errors until you re-enable.
{"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":""},"feedback":{"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5d790aa1faedf27c32b42","clientVersion":"0.0.4124","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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"inference/overview","slug":"/inference/overview","pageMetadata":{"title":"Overview","description":"Run LLM inference on Pinata with an OpenAI-compatible API","icon":"bolt","href":"/inference/overview"},"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: \"Run LLM inference on Pinata with an OpenAI-compatible 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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading,Note,Table,Tip,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Pinata Inference is a hosted, OpenAI-compatible LLM endpoint. Enable it on your account, then use it two ways:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`API`}),` — point any OpenAI-compatible client at Pinata and call `,_jsx(_components.a,{href:`/inference/chat-completions`,children:`chat completions`}),` directly, no agent required.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Agents app`}),` — the same hosted models show up alongside your other providers in an agent’s `,_jsx(_components.a,{href:`/agents/models`,children:`Models`}),` list (connect the `,_jsx(_components.strong,{children:`Pinata`}),` provider in the `,_jsx(_components.a,{href:`/agents/secrets#connect-a-provider`,children:`Secrets Vault`}),`).`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Either way, requests run against the `,_jsx(_components.a,{href:`/inference/models`,children:`models`}),` Pinata hosts, and usage is metered and drawn down from your `,_jsx(_components.a,{href:`/inference/credits`,children:`credit balance`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Inference is billed through credits. Before your first request, make sure your workspace has a credit balance and (optionally) `,_jsx(_components.a,{href:`/inference/credits#auto-top-up`,children:`auto top-up`}),` enabled so requests don’t fail on an empty balance.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`enable-inference`,children:`Enable inference`}),`\n`,_jsx(_components.p,{children:`Turn Pinata-hosted inference on for your account with a single call, authenticated with your standard Pinata JWT:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,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:`2`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://agents.pinata.cloud/v0/llm/enable`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PINATA_JWT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`Response`,numberOfLines:`4`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,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:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"privateKey\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cyour-inference-key>\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Enabling generates an Ed25519 key pair: the `,_jsx(_components.strong,{children:`private key is returned once`}),` in this response and also stored encrypted in your `,_jsx(_components.a,{href:`/agents/secrets`,children:`secrets`}),` as `,_jsx(_components.code,{children:`PINATA_LLM_KEY`}),`; the public key is kept for request validation.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`privateKey`}),` is your inference credential — it’s what authenticates `,_jsx(_components.a,{href:`/inference/chat-completions`,children:`chat completions`}),`, `,_jsx(_components.strong,{children:`not`}),` your Pinata JWT. Save it now; it isn’t returned again.`]})}),`\n`,_jsxs(_components.p,{children:[`Once enabled, the `,_jsx(_components.a,{href:`/inference/chat-completions`,children:`chat completions endpoint`}),` accepts requests and usage starts drawing down your `,_jsx(_components.a,{href:`/inference/credits`,children:`credit balance`}),`.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Prefer the dashboard? Connecting the `,_jsx(_components.strong,{children:`Pinata`}),` provider in the `,_jsx(_components.a,{href:`/agents/secrets#connect-a-provider`,children:`Secrets Vault`}),` does the same thing, and is also how Pinata-hosted models become selectable inside your agents.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`check-status`,children:`Check status`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,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:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://agents.pinata.cloud/v0/llm/status`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PINATA_JWT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`Response`,numberOfLines:`1`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"enabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-06-29T00:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`disable-inference`,children:`Disable inference`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,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:`2`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` DELETE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://agents.pinata.cloud/v0/llm/disable`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PINATA_JWT`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`Response`,numberOfLines:`1`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Disabling revokes the inference key and removes the associated secrets. New requests to the chat completions endpoint are rejected and Pinata-hosted models are no longer selectable in agents — any running agents using the managed key are automatically flipped to the `,_jsx(_components.a,{href:`/agents/models#free-tier-agents`,children:`free tier`}),` fallback so they don’t break. Your credit balance is untouched — disabling does not refund or expire credits — and you can re-enable at any time (which mints a `,_jsx(_components.strong,{children:`new`}),` `,_jsx(_components.code,{children:`privateKey`}),`).`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Disabling takes effect immediately. Any in-flight requests may be cut off, and anything pointing at the endpoint will start getting errors until you re-enable.`})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`There are two credentials, used for different routes:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Routes`}),_jsx(_components.th,{children:`Credential`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Management`}),` — `,_jsx(_components.code,{children:`enable`}),`, `,_jsx(_components.code,{children:`disable`}),`, `,_jsx(_components.code,{children:`status`})]}),_jsxs(_components.td,{children:[`Your `,_jsx(_components.strong,{children:`Pinata JWT`}),` (from `,_jsx(_components.a,{href:`/account-management/api-keys`,children:`Account → API Keys`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Inference`}),` — `,_jsx(_components.code,{children:`chat/completions`})]}),_jsxs(_components.td,{children:[`The `,_jsx(_components.strong,{children:_jsx(_components.code,{children:`privateKey`})}),` returned when you enabled (stored as the `,_jsx(_components.code,{children:`PINATA_LLM_KEY`}),` secret)`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Catalog`}),` — `,_jsx(_components.code,{children:`models`})]}),_jsx(_components.td,{children:`None — public`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Management`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer \u003cPINATA_JWT>`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Inference`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer \u003cPINATA_LLM_KEY>`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Chat Completions`,icon:`message`,href:`/inference/chat-completions`,children:_jsx(_components.p,{children:`Call the OpenAI-compatible endpoint`})}),_jsx(Card,{title:`Models`,icon:`microchip`,href:`/inference/models`,children:_jsx(_components.p,{children:`See which models Pinata hosts`})}),_jsx(Card,{title:`Credits`,icon:`coins`,href:`/inference/credits`,children:_jsx(_components.p,{children:`Fund usage and set auto top-up`})})]})]})}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":"Overview","description":"Run LLM inference on Pinata with an OpenAI-compatible API","icon":"bolt","href":"/inference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Enable inference","slug":"enable-inference","depth":2,"children":[{"title":"Check status","slug":"check-status","depth":3,"children":[]}]},{"title":"Disable inference","slug":"disable-inference","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/pinata/0188189cb1e45a94/reo.js"],"subdomain":"pinata","siteName":"Pinata Docs","title":"Overview - Pinata Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-30T18:01:47.651Z","originalFileLocation":"inference/overview.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=\"Run LLM inference on Pinata with an OpenAI-compatible 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=\"Overview - Pinata Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run LLM inference on Pinata with an OpenAI-compatible API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pinata Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pinata.cloud/inference/overview\">\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=\"Overview - Pinata Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run LLM inference on Pinata with an OpenAI-compatible 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/inference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/inference/overview.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/inference/overview#webpage\",\"url\":\"https://docs.pinata.cloud/inference/overview\",\"name\":\"Overview\",\"description\":\"Run LLM inference on Pinata with an OpenAI-compatible API\",\"dateModified\":\"2026-06-30T18:01:47.651Z\",\"isPartOf\":{\"@id\":\"https://docs.pinata.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinata.cloud/inference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinata.cloud/inference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"AI\",\"item\":\"https://docs.pinata.cloud/agents/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.pinata.cloud/inference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.pinata.cloud/inference/overview#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Run LLM inference on Pinata with an OpenAI-compatible API\",\"url\":\"https://docs.pinata.cloud/inference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinata.cloud/inference/overview#webpage\"},\"image\":\"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm\",\"dateModified\":\"2026-06-30T18:01:47.651Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pinata Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/inference/overview.md","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","groups":[{"group":"Get Started","pages":[{"title":"Quickstart","icon":"stopwatch","href":"/quickstart"},{"group":"Frameworks","icon":"react","pages":[{"title":"Next.js","icon":"n","href":"/frameworks/next-js"},{"title":"Hono","icon":"fire","href":"/frameworks/hono"},{"title":"React","icon":"react","href":"/frameworks/react"},{"title":"SvelteKit","icon":"s","href":"/frameworks/sveltekit"},{"title":"Astro","icon":"rocket-launch","href":"/frameworks/astro"},{"title":"Remix","icon":"compact-disc","href":"/frameworks/remix"},{"title":"Node.js","icon":"node-js","href":"/frameworks/node-js"}]}]},{"group":"AI","pages":[{"group":"Agents","icon":"lobster","pages":[{"title":"Overview","icon":"lobster","href":"/agents/overview"},{"title":"Concepts","icon":"compass","href":"/agents/concepts"},{"title":"Chat","icon":"message","href":"/agents/chat"},{"title":"Issues \u0026 Boards","sidebarTitle":"Issues","icon":"table-columns","href":"/agents/issues"},{"title":"Secrets","icon":"key","href":"/agents/secrets"},{"title":"Models","icon":"microchip","href":"/agents/models"},{"title":"Skills","icon":"wand-magic-sparkles","href":"/agents/skills"},{"title":"Channels","icon":"comments","href":"/agents/channels"},{"title":"Domains \u0026 Routes","sidebarTitle":"Routes","icon":"network-wired","href":"/agents/routes"},{"title":"Tasks","icon":"clock","href":"/agents/tasks"},{"title":"Files \u0026 Snapshots","sidebarTitle":"Files","icon":"folder-open","href":"/agents/snapshots"},{"group":"Dev Tools","icon":"terminal","pages":[{"title":"Console","icon":"terminal","href":"/agents/console"},{"title":"Logs","icon":"scroll","href":"/agents/logs"},{"title":"Danger","icon":"triangle-exclamation","href":"/agents/devtools"}]},{"group":"Build","icon":"code","pages":[{"title":"Manifest Reference","sidebarTitle":"Manifest","icon":"file-code","href":"/agents/manifest"},{"title":"HTTP API","sidebarTitle":"HTTP API","icon":"plug","href":"/agents/api"}]},{"group":"Templates","icon":"clone","pages":[{"title":"Templates","sidebarTitle":"Overview","icon":"grid-2","href":"/agents/templates/overview"},{"title":"Creating Templates","icon":"hammer","href":"/agents/templates/creating"}]},{"group":"Troubleshooting","icon":"wrench","pages":[{"title":"Troubleshooting","icon":"wrench","href":"/agents/troubleshooting"},{"title":"Error Reference","sidebarTitle":"Errors","description":"Look up an API error code and how to resolve it","icon":"circle-exclamation","href":"/agents/errors"}]}]},{"group":"Inference","icon":"bolt","pages":[{"title":"Overview","icon":"bolt","href":"/inference/overview"},{"title":"Chat Completions","description":"OpenAI-compatible chat completions endpoint","icon":"message","href":"/inference/chat-completions"},{"title":"Models","icon":"microchip","href":"/inference/models"}]},{"title":"Credits","icon":"coins","href":"/inference/credits"},{"title":"Agents CLI","icon":"robot","href":"/tools/cli/agents"},{"title":"LLM Docs","icon":"sparkles","href":"/llm-docs"},{"group":"MCP Server","icon":"plug","pages":[{"title":"Overview","href":"/tools/mcp/overview"},{"title":"Tools Reference","href":"/tools/mcp/tools"}]},{"group":"ERC-8004","icon":"robot","pages":[{"title":"Quickstart","href":"/tools/erc-8004/quickstart"},{"title":"Services \u0026 IPFS","href":"/tools/erc-8004/services"}]}]},{"group":"Account Management","pages":[{"title":"API Keys","icon":"key","href":"/account-management/api-keys"},{"title":"Workspaces","icon":"user-group","hidden":false,"href":"/account-management/workspaces"},{"title":"Webhooks","icon":"webhook","href":"/account-management/webhooks"},{"title":"Billing","icon":"money-bill","hidden":false,"href":"/account-management/billing"},{"title":"Limits","icon":"gauge","href":"/account-management/limits"}]},{"group":"Files","pages":[{"title":"Uploading Files","icon":"file-arrow-up","href":"/files/uploading-files"},{"title":"Presigned URLs","icon":"signature","href":"/files/presigned-urls"},{"title":"List \u0026 Query Files","icon":"list","href":"/files/listing-files"},{"title":"Deleting Files","icon":"trash","href":"/files/deleting-files"},{"title":"Retrieving Files","icon":"globe-pointer","href":"/gateways/retrieving-files"},{"title":"Groups","icon":"ball-pile","href":"/files/file-groups"},{"title":"Key-Values","icon":"database","href":"/files/key-values"},{"title":"Private IPFS","icon":"lock","href":"/files/private-ipfs"},{"title":"File Vectors (Beta)","icon":"microchip-ai","href":"/files/vectors"},{"title":"Signatures","icon":"file-signature","href":"/files/signatures"},{"group":"CLI","icon":"terminal","pages":[{"title":"CLI Overview","icon":"terminal","href":"/tools/cli/overview"},{"title":"IPFS","icon":"cube","href":"/tools/cli/ipfs"},{"title":"Agents CLI","icon":"robot","href":"/tools/cli/agents"}]},{"group":"MPP Server","icon":"coins","pages":[{"title":"MPP Server","href":"/files/mpp/overview"},{"title":"Quick Start","href":"/files/mpp/quickstart"}]},{"group":"x402","icon":"sparkle","pages":[{"group":"x402 Monetization","pages":[{"title":"Introduction","href":"/files/x402/intro"},{"title":"Quick Start","href":"/files/x402/x402-quick-start"},{"title":"Payment Instructions Guide","href":"/files/x402/x402-payment-instructions"},{"title":"Accessing Paid Content","href":"/files/x402/x402-accessing-paid-content"}]},{"title":"x402 Services","href":"/files/x402/x402-services"}]},{"group":"NFT Backup","icon":"cloud-arrow-up","pages":[{"title":"Overview","href":"/files/nft-backup/overview"},{"title":"Wallets","href":"/files/nft-backup/wallets"},{"title":"Collections","href":"/files/nft-backup/collections"},{"title":"Sync","href":"/files/nft-backup/sync"}]}]},{"group":"Gateways","pages":[{"title":"Dedicated IPFS Gateways","icon":"globe-pointer","href":"/gateways/dedicated-ipfs-gateways"},{"title":"Gateway Access Controls","icon":"shield-keyhole","href":"/gateways/gateway-access-controls"},{"title":"Image Optimizations","icon":"image","href":"/gateways/image-optimizations"},{"group":"Plugins","icon":"puzzle-piece-simple","pages":[{"title":"Getting Started","icon":"play","href":"/gateways/plugins/getting-started"},{"title":"Content Addressable","icon":"file-signature","href":"/gateways/plugins/content-addressable"},{"title":"Hot Swaps","icon":"rotate","href":"/gateways/plugins/hot-swaps"}]}]},{"group":"Additional Resources","pages":[{"title":"Pinata Expo Hooks","icon":"angle-up","href":"/tools/pinata-expo-hooks"},{"title":"Community SDKs","icon":"laptop-code","href":"/tools/community-sdks"},{"group":"IPFS 101","icon":"cube","pages":[{"title":"What is IPFS?","hidden":false,"href":"/ipfs-101/what-is-ipfs"},{"title":"What is Pinning?","hidden":false,"href":"/ipfs-101/what-is-ipfs-pinning"},{"title":"What are CIDs?","hidden":false,"href":"/ipfs-101/what-are-cids"},{"title":"What are IPFS Gateways?","hidden":false,"href":"/ipfs-101/what-are-ipfs-gateways"},{"title":"How does IPFS work with NFTs?","hidden":false,"href":"/ipfs-101/how-does-ipfs-work-with-nfts"}]}]}]},{"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","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}","href":"/api-reference/endpoint/x402/retrieve"}]}]}]},{"version":"legacy","pages":[{"title":"legacy","href":"/api-reference/introduction"}]}]}]},"basePath":"","title":"Overview - Pinata Docs","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":[],"chunks":[]}