Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion account-management/api-keys.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "API Keys"
title: "API keys"
description: "Create, scope, and revoke Pinata API keys from the dashboard, then authenticate requests to the Files API and legacy IPFS API with a JWT."
slug: "api-keys"
icon: "key"
---
Expand Down
3 changes: 2 additions & 1 deletion account-management/billing.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Billing"
title: "Billing and usage"
description: "Upgrade your Pinata plan, monitor monthly storage and gateway bandwidth usage, and update payment methods from the billing dashboard."
slug: "billing"
icon: "money-bill"
excerpt: "https://app.pinata.cloud/billing"
Expand Down
3 changes: 2 additions & 1 deletion account-management/limits.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Limits"
title: "Pinata rate limits and plan limits"
description: "Reference for Pinata API rate limits, gateway request caps, and storage allowances across Free, Picnic, Fiesta, and Enterprise plans."
icon: "gauge"
---

Expand Down
2 changes: 1 addition & 1 deletion account-management/webhooks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Webhooks"
description: "Subscribe to Pinata API events using Webhooks"
description: "Subscribe a server endpoint to Pinata events like uploads and deletes so your app reacts to file activity in real time using webhooks."
icon: "webhook"
---

Expand Down
3 changes: 2 additions & 1 deletion account-management/workspaces.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Workspaces"
title: "Workspaces and team collaboration"
description: "Invite teammates to a shared Pinata workspace, manage seats on Picnic and Fiesta plans, and collaborate on uploads, gateways, and groups."
slug: "workspaces"
icon: "user-group"
excerpt: ""
Expand Down
4 changes: 2 additions & 2 deletions agents/api.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "HTTP API"
title: "Pinata Agents HTTP API reference"
sidebarTitle: "HTTP API"
description: "Authenticate, manage agents, and talk to gateways over HTTP"
description: "Authenticate, manage AI agents, run commands, and talk to gateways over the Pinata Agents HTTP API with examples for every endpoint."
icon: "plug"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/channels.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Channels"
description: "Let people talk to your agent on Telegram, Slack, or Discord"
title: "Agent channels: Telegram, Slack, Discord"
description: "Connect your Pinata agent to Telegram, Slack, or Discord so users can chat with it directly from the messaging apps they already use."
icon: "comments"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/chat.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Chat"
description: "Talk to your agent through the web interface"
title: "Chat with your Pinata agent"
description: "Talk to your hosted Pinata agent through the web chat interface, share context, attach files, and review the agent's actions in one place."
icon: "message"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/concepts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Concepts"
description: "Terms, file layout, and how the pieces fit together"
title: "Pinata Agents concepts and architecture"
description: "Learn the terminology, file layout, runtime model, and architecture behind Pinata Agents so you can reason about how the pieces fit together."
icon: "compass"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/console.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Console"
description: "A real terminal inside your agent's container"
title: "Agent console: terminal access"
description: "Open a real interactive terminal inside your Pinata agent's container to inspect files, run commands, and debug issues in real time."
icon: "terminal"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/devtools.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Danger"
description: "Full agent inventory, plus restart and delete"
title: "Agent inventory, restart, and delete"
description: "Use the Danger panel to view your full Pinata agent inventory, restart misbehaving agents, and permanently delete agents you no longer need."
icon: "triangle-exclamation"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/errors.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Error Reference"
title: "Pinata Agents API error reference"
sidebarTitle: "Errors"
description: "Look up an API error code and how to resolve it"
description: "Look up any Pinata Agents API error code, understand what it means, and follow the steps required to resolve the issue and unblock your agent."
icon: "circle-exclamation"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/issues.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Issues & Boards"
title: "Agent issues and kanban boards"
sidebarTitle: "Issues"
description: "Assign work to agents on a kanban board, review the diff, ship it"
description: "Assign work to Pinata agents on a kanban board, review the diffs they produce, request changes, and ship completed pull requests to your repo."
icon: "table-columns"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/logs.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Logs"
description: "Stream your agent engine's output in real time"
title: "Stream Pinata agent engine logs"
description: "Stream the live output from your Pinata agent's engine, follow tool calls and model responses, and debug runs as they happen in real time."
icon: "scroll"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/manifest.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Manifest Reference"
title: "Pinata agent manifest.json reference"
sidebarTitle: "Manifest"
description: "Every field in manifest.json, the source of truth for an agent's configuration"
description: "Reference for every field in manifest.json, the source of truth for a Pinata agent's models, skills, secrets, routes, and runtime configuration."
icon: "file-code"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/models.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Models"
description: "Pick which AI models this agent can use"
title: "Choose AI models for your Pinata agent"
description: "Pick which large language models your Pinata agent can call, mix providers, and control which model handles chat, tools, and background tasks."
icon: "microchip"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Overview"
description: "Hosted AI agents that can run code, manage files, and connect to other services"
title: "Pinata Agents overview"
description: "Pinata Agents are hosted AI agents that run code, manage files, call external services, and integrate with chat platforms, all from one dashboard."
icon: "lobster"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/routes.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Domains & Routes"
title: "Agent domains and HTTP routes"
sidebarTitle: "Routes"
description: "Expose web services from inside your agent to the internet"
description: "Expose web services running inside your Pinata agent to the internet using custom domains and HTTP routes, complete with TLS and auth options."
icon: "network-wired"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/secrets.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Secrets"
description: "Where API keys and credentials live"
title: "Manage agent secrets and API keys"
description: "Store API keys, tokens, and credentials your Pinata agent needs to call external services, scoped per agent and injected at runtime safely."
icon: "key"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/skills.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Skills"
description: "Reusable capability packages you can attach to an agent"
title: "Agent skills: reusable capabilities"
description: "Skills are reusable capability packages you attach to a Pinata agent to add new tools, integrations, and behavior without rewriting the manifest."
icon: "wand-magic-sparkles"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/snapshots.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Files & Snapshots"
title: "Agent files and workspace snapshots"
sidebarTitle: "Files"
description: "Browse, version, and edit your agent's workspace"
description: "Browse, version, and edit your Pinata agent's workspace from the dashboard, then roll back to any earlier snapshot when something goes wrong."
icon: "folder-open"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/tasks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Tasks"
description: "Run prompts on a schedule"
title: "Schedule recurring tasks for an agent"
description: "Run prompts against your Pinata agent on a schedule using cron expressions so it can monitor sources, send reports, and perform routine work."
icon: "clock"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/templates/creating.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Creating Templates"
description: "Share your agent configuration as a template"
title: "Create and publish an agent template"
description: "Package and share your Pinata agent configuration as a reusable template so other developers can deploy preconfigured agents in one click."
icon: "hammer"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/templates/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Templates"
title: "Agent templates: one-click deploys"
sidebarTitle: "Overview"
description: "Deploy pre-configured agents in one click"
description: "Deploy preconfigured Pinata agents in a single click, browse community templates, and use them as starting points for your own AI agents."
icon: "grid-2"
---

Expand Down
4 changes: 2 additions & 2 deletions agents/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Troubleshooting"
description: "What to check when your agent isn't behaving"
title: "Troubleshoot a misbehaving Pinata agent"
description: "Diagnostic checklist for fixing a Pinata agent that won't start, ignores instructions, fails tool calls, or burns through context unexpectedly."
icon: "wrench"
---

Expand Down
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/add-cids-to-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Add one or more IPFS CIDs to an existing group on Pinata so you can organize and query pins together through the legacy IPFS API endpoints."
openapi: put /groups/{id}/cids
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/add-swap.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Create a Hot Swap mapping on the legacy IPFS API so requests for one CID are silently served the content of a different, updated CID instead."
openapi: put /ipfs/swap/{cid}
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/create-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Create a new IPFS group on Pinata's legacy API. Groups let you organize pinned CIDs so you can manage and filter them by a single name."
openapi: post /groups
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/delete-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Delete an existing IPFS group on Pinata's legacy API. Pinned CIDs that were members of the group are not unpinned by this operation."
openapi: delete /groups/{id}
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/get-a-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Fetch metadata about a single IPFS group on Pinata's legacy API, including its name, ID, creation timestamp, and last-updated timestamp."
openapi: get /groups/{id}
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/get-swap-history.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Return every Hot Swap mapping that has ever been registered against a given IPFS CID using Pinata's legacy IPFS API hot swap endpoints."
openapi: get /ipfs/swap/{cid}
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/list-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "List the IPFS groups on your Pinata account using the legacy IPFS API, with pagination and name filters to find specific organized pin sets."
openapi: get /groups
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/remove-cids-from-a-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Remove one or more IPFS CIDs from a group on Pinata's legacy API. The underlying pins remain on your account and are not unpinned by this call."
openapi: delete /groups/{id}/cids
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/remove-swap.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Delete an existing Hot Swap mapping on Pinata's legacy IPFS API so requests for the original CID resume serving its original content again."
openapi: delete /ipfs/swap/{cid}
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/revoke-api-key.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Revoke an existing Pinata legacy IPFS API key by its key value so it can no longer be used to authenticate requests against the legacy API."
openapi: put /users/revokeApiKey
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/update-file-metadata.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Update the name and key-value metadata stored for a pinned IPFS CID on Pinata's legacy IPFS API. The underlying pinned content stays untouched."
openapi: put /pinning/hashMetadata
---
1 change: 1 addition & 0 deletions api-reference/endpoint/ipfs/update-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Update the name of an existing IPFS group on Pinata's legacy IPFS API. The group ID and its member CID list are preserved by this operation."
openapi: put /groups/{id}
---
4 changes: 2 additions & 2 deletions api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Introduction"
description: "Getting started with the Pinata API"
title: "Pinata API introduction and authentication"
description: "Start with the Pinata API: authenticate with a JWT, pick between the v3 Files API and IPFS API, and find endpoints for uploads and gateways."
---

Welcome to the Pinata API Reference! Before you can do anything in the API, you'll need some API Keys.
Expand Down
3 changes: 2 additions & 1 deletion api-reference/pinning-service-api.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Pinning Service API"
title: "Pinning Service API compatibility"
description: "Connect a local IPFS node to Pinata using the standardized IPFS Pinning Services API spec, with authentication and supported endpoints."
slug: "pinning-service-api"
excerpt: ""
hidden: false
Expand Down
2 changes: 1 addition & 1 deletion events/hackutd.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "HackUTD 2024"
description: "Everything you need to start hacking with Pinata"
description: "HackUTD 2024 resource hub for hackers building with Pinata: API keys, IPFS uploads, gateways, sample projects, and prize-track requirements."
'og:image': "https://dweb.mypinata.cloud/files/bafkreibd7kj7qviao4nx67kvcqhm7gx2mfd5ntemrlsofpbgxlfnbnlg3u?img-format=webp"
---

Expand Down
2 changes: 1 addition & 1 deletion events/midwest-blockathon.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Midwest Blockathon"
description: "Everything you need to start hacking with Pinata"
description: "Midwest Blockathon resources for building with Pinata: free API keys, IPFS upload guides, NFT examples, and Web3 storage starter projects."
'og:image': "https://dweb.mypinata.cloud/ipfs/bafybeiddzixjmwioazvyokgd4kjep45tuvosgeizenekk2ifrcznqsfb5m"
---

Expand Down
2 changes: 1 addition & 1 deletion events/midwest-blockchain-conference.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Midwest Blockchain Conference"
description: "Everything you need to start hacking with Pinata"
description: "Midwest Blockchain Conference workshop resources for Pinata, IPFS uploads, Dedicated Gateways, NFTs, and getting started with Web3 storage."
---

![MBC Graphic Large.png](/images/MBCGraphicLarge.png)
Expand Down
2 changes: 1 addition & 1 deletion events/ugahacks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "UGA Hacks"
description: "Everything you need to start hacking with Pinata"
description: "UGA Hacks resource page for hackers using Pinata: claim free API keys, upload to IPFS, serve files through gateways, and find starter templates."
'og:image': "https://dweb.mypinata.cloud/ipfs/bafybeic2xw7xptzy53rtsksecjdzmygliwlqalqkaipq4wwap4kchxg47y"
---

Expand Down
1 change: 1 addition & 0 deletions files/deleting-files.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Deleting Files"
description: "Delete files from Pinata permanently using the SDK delete method, the Files API, or the dashboard to remove single files or files in bulk."
icon: "trash"
---

Expand Down
3 changes: 2 additions & 1 deletion files/file-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Groups"
title: "Organize uploads with file groups"
description: "Use Pinata groups to organize your uploads through the app, SDK, or API, add and remove files, and keep track of what each set of CIDs is for."
icon: "ball-pile"
---

Expand Down
2 changes: 1 addition & 1 deletion files/hot-swaps.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Hot Swaps"
description: "Use the Hot Swaps plugin to make one CID map to another"
description: "Map one IPFS CID to another with the Pinata Hot Swaps plugin so you can update content served from a stable CID without breaking existing links."
---

The Hot Swaps plugin can be used to "redirect" a CID to another CID. This can be useful when you need to replace content without updaing the CID hash. What makes this unique from just replacing content is that every swap is recorded and is available as a history. Combine that with the content addressable nature of CIDs and you get a version history of content.
Expand Down
1 change: 1 addition & 0 deletions files/key-values.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Key-Values"
description: "Attach up to ten custom key-value pairs to any Pinata upload so you can tag, query, and update files with metadata that fits your app's needs."
icon: "database"
---

Expand Down
3 changes: 2 additions & 1 deletion files/listing-files.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "List & Query Files"
title: "List and query files on Pinata"
description: "Query files uploaded to Pinata by name, key-value tags, group, date, and more using the SDK or Files API to power dashboards and search."
icon: "list"
---

Expand Down
2 changes: 1 addition & 1 deletion files/mpp/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "MPP Server"
description: "Account-free IPFS uploads and downloads using crypto payments via the Machine Payments Protocol"
description: "The MPP Server enables account-free IPFS uploads and downloads using crypto payments via the Machine Payments Protocol on Cloudflare Workers."
---

Pinata's MPP Server enables account-free file uploads and downloads to IPFS using crypto payments. No API key or Pinata account required — just pay with USDC on Tempo and get your files stored on IPFS.
Expand Down
Loading