That example is an OpenClaw agent. Hermes agents use /home/hermes/data/workspace. The current path is also shown on the agent’s Danger tab.Anything you can do with a shell, you can do here:
Run bash, python, node, git, curl, jq
Tail log files: tail -f /tmp/user-build.log
Check what the agent sees: env | sort
Confirm a service is listening: ss -tlnp
Edit a file with vi or nano
The session starts in the engine’s workspace directory — the same workspace shown on the Files and Danger tabs. Skills live under skills/, uploaded files under uploads/.
The button in the top-right of the panel switches to fullscreen mode, which is much more pleasant for anything beyond a one-liner.
When to reach for the Console
The Console is the second-best debugging tool, after Logs. Use it when:
Logs show an error and you need to look at a file to understand it
A lifecycle script failed and you want to read /tmp/user-build.log or /tmp/user-start.log
You want to confirm a process is actually running (ps aux | grep <name>)
You want to reproduce a one-off command the agent ran
Quick checks worth knowing:
# What did the build script say?tail -n 200 /tmp/user-build.log# What did the start script say?tail -n 200 /tmp/user-start.log# Latest OpenClaw log (OpenClaw agents)ls -la /tmp/openclaw/# OpenClaw runtime configcat /home/node/.openclaw/openclaw.json# Hermes runtime configcat /home/hermes/data/config.yaml# Manifest the agent is usingcat manifest.json# Is anything listening on common dev ports?ss -tlnp
If you’re scripting against an agent, hit the API:Set cwd to the workspace path for that engine. For OpenClaw that’s /home/node/clawd/workspace; for Hermes that’s /home/hermes/data/workspace.
{"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":"6afb75297e21e275fdc59f0b","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"SDK","count":85},{"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":27},{"language":"default","tag":"public","count":27},{"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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"agents/console","slug":"/agents/console","pageMetadata":{"title":"Console","description":"A real terminal inside your agent's container","icon":"terminal","href":"/agents/console"},"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: \"A real terminal inside your agent’s container\"\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`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,OptimizedImage,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Console tab is a shell. You get an interactive prompt inside your agent’s container, with the same workspace your agent reads and writes.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=b0dd6644beb48a7e5ffc8ab1522bc684`,alt:`Image`,\"data-og-width\":`1969`,width:`1969`,\"data-og-height\":`1358`,height:`1358`,\"data-path\":`images/image-37.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?w=280\u0026fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=60b6cde5874a25815bb2dea8d93949ea 280w, https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?w=560\u0026fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=fe5645a604da0ca07d8ad69db865d9f8 560w, https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?w=840\u0026fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=53ad1baaa6ed5f5e7005cfbc923db302 840w, https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?w=1100\u0026fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=119576ab32c964aa7a9d647df923312d 1100w, https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?w=1650\u0026fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=efc3a5a66be5e5a40eb13a9d23036eee 1650w, https://mintcdn.com/pinata/p6XBuxeipyyP6Ugl/images/image-37.png?w=2500\u0026fit=max\u0026auto=format\u0026n=p6XBuxeipyyP6Ugl\u0026q=85\u0026s=d5bb286e301498c186dc622ce73e6a32 2500w`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`--- Agent Console ---`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Working directory: /home/node/clawd/workspace`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`~/clawd/workspace $`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`That example is an OpenClaw agent. Hermes agents use `,_jsx(_components.code,{children:`/home/hermes/data/workspace`}),`. The current path is also shown on the agent’s `,_jsx(_components.a,{href:`/agents/devtools`,children:`Danger`}),` tab.`]}),`\n`,_jsx(_components.p,{children:`Anything you can do with a shell, you can do here:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Run `,_jsx(_components.code,{children:`bash`}),`, `,_jsx(_components.code,{children:`python`}),`, `,_jsx(_components.code,{children:`node`}),`, `,_jsx(_components.code,{children:`git`}),`, `,_jsx(_components.code,{children:`curl`}),`, `,_jsx(_components.code,{children:`jq`})]}),`\n`,_jsxs(_components.li,{children:[`Tail log files: `,_jsx(_components.code,{children:`tail -f /tmp/user-build.log`})]}),`\n`,_jsxs(_components.li,{children:[`Check what the agent sees: `,_jsx(_components.code,{children:`env | sort`})]}),`\n`,_jsxs(_components.li,{children:[`Confirm a service is listening: `,_jsx(_components.code,{children:`ss -tlnp`})]}),`\n`,_jsxs(_components.li,{children:[`Edit a file with `,_jsx(_components.code,{children:`vi`}),` or `,_jsx(_components.code,{children:`nano`})]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`The session starts in the engine’s workspace directory — the same workspace shown on the Files and Danger tabs. Skills live under `,_jsx(_components.code,{children:`skills/`}),`, uploaded files under `,_jsx(_components.code,{children:`uploads/`}),`.`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`The button in the top-right of the panel switches to fullscreen mode, which is much more pleasant for anything beyond a one-liner.`})}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-reach-for-the-console`,children:`When to reach for the Console`}),`\n`,_jsx(_components.p,{children:`The Console is the second-best debugging tool, after Logs. Use it when:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Logs show an error and you need to look at a file to understand it`}),`\n`,_jsxs(_components.li,{children:[`A lifecycle script failed and you want to read `,_jsx(_components.code,{children:`/tmp/user-build.log`}),` or `,_jsx(_components.code,{children:`/tmp/user-start.log`})]}),`\n`,_jsxs(_components.li,{children:[`You want to confirm a process is actually running (`,_jsx(_components.code,{children:`ps aux | grep \u003cname>`}),`)`]}),`\n`,_jsx(_components.li,{children:`You want to reproduce a one-off command the agent ran`}),`\n`]}),`\n`,_jsx(_components.p,{children:`Quick checks worth knowing:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`20`,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:`20`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# What did the build script say?`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`tail`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -n`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 200`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /tmp/user-build.log`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# What did the start script say?`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`tail`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -n`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 200`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /tmp/user-start.log`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Latest OpenClaw log (OpenClaw agents)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`ls`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -la`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /tmp/openclaw/`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# OpenClaw runtime config`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cat`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /home/node/.openclaw/openclaw.json`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Hermes runtime config`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cat`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /home/hermes/data/config.yaml`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Manifest the agent is using`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cat`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` manifest.json`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Is anything listening on common dev ports?`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`ss`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -tlnp`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`For workflows by symptom, see `,_jsx(_components.a,{href:`/agents/troubleshooting`,children:`Troubleshooting`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`running-a-command-from-outside-the-ui`,children:`Running a command from outside the UI`}),`\n`,_jsx(_components.p,{children:`If you’re scripting against an agent, hit the API:`}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`cwd`}),` to the workspace path for that engine. For OpenClaw that’s `,_jsx(_components.code,{children:`/home/node/clawd/workspace`}),`; for Hermes that’s `,_jsx(_components.code,{children:`/home/hermes/data/workspace`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,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:`#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:`\"`}),_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:` \"Content-Type: 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:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"command\":\"ls -la\",\"cwd\":\"/home/node/clawd/workspace\"}'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://agents.pinata.cloud/v0/agents/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$AGENT_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/console/exec`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The response is JSON: `,_jsx(_components.code,{children:`{ stdout, stderr, exitCode, command, timestamp }`}),`.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Console access is full shell access. Anyone with the gateway token has it. Treat the token like a server credential.`})})]})}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":"Console","description":"A real terminal inside your agent's container","icon":"terminal","href":"/agents/console"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"When to reach for the Console","slug":"when-to-reach-for-the-console","depth":2,"children":[]},{"title":"Running a command from outside the UI","slug":"running-a-command-from-outside-the-ui","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/pinata/0188189cb1e45a94/reo.js"],"subdomain":"pinata","siteName":"Pinata Docs","title":"Console - Pinata Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-02T17:12:25.202Z","originalFileLocation":"agents/console.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=\"A real terminal inside your agent\u0026#x27;s container\">\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=\"Console - Pinata Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"A real terminal inside your agent\u0026#x27;s container\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pinata Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pinata.cloud/agents/console\">\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=\"Console - Pinata Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A real terminal inside your agent\u0026#x27;s container\">\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/agents/console\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/agents/console.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/agents/console#webpage\",\"url\":\"https://docs.pinata.cloud/agents/console\",\"name\":\"Console\",\"description\":\"A real terminal inside your agent's container\",\"dateModified\":\"2026-06-02T17:12:25.202Z\",\"isPartOf\":{\"@id\":\"https://docs.pinata.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pinata.cloud/agents/console#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pinata.cloud/agents/console#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"AI\",\"item\":\"https://docs.pinata.cloud/agents/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.pinata.cloud/agents/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Console\",\"item\":\"https://docs.pinata.cloud/agents/console\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.pinata.cloud/agents/console#article\",\"headline\":\"Console\",\"name\":\"Console\",\"description\":\"A real terminal inside your agent's container\",\"url\":\"https://docs.pinata.cloud/agents/console\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pinata.cloud/agents/console#webpage\"},\"image\":\"https://docs.mypinata.cloud/ipfs/bafkreicvhjv5mipe2mk4uiq77tg5ykl7qevnj43ubonhtfj5jcseflxvsm\",\"dateModified\":\"2026-06-02T17:12:25.202Z\",\"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":"/agents/console.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","description":"Browse, version, and edit your agent's workspace","icon":"folder-open","href":"/agents/snapshots"},{"group":"Dev Tools","icon":"terminal","pages":[{"title":"Console","icon":"terminal","href":"/agents/console"},{"title":"Logs","description":"Stream your agent engine's output in real time","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","icon":"circle-exclamation","href":"/agents/errors"}]}]},{"group":"Inference","icon":"bolt","pages":[{"title":"Overview","icon":"bolt","href":"/inference/overview"},{"title":"Chat Completions","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":"Console - Pinata Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-BRsfsIIG.js","DynamicMarkdown-NFqqduU7.js","zoom-image-lightbox-BguUeq2N.js","lightbox-handle-r17bVUz3.js"]}