Upstash llms.txt

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Showing the first 18000 characters. Load the complete file to read the remainder.

# Upstash Documentation

<Tip>
  If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.

  Upstash also provides an MCP server (/docs/agent-resources/mcp) to manage and debug your Upstash resources directly from an agent, and an agent-friendly CLI (/docs/agent-resources/cli) for your terminal or CI/CD pipelines.
</Tip>

## Search

Search these docs: GET https://upstash.com/docs/search?q=<query> returns JSON { results: [{ href, title, heading, snippet, tab }] }. Append .md to any page href for its markdown.

## Docs

- [README](https://upstash.com/docs/README.md)
- [CLI](https://upstash.com/docs/agent-resources/cli.md)
- [Install by agent](https://upstash.com/docs/agent-resources/clients.md): Set up the Upstash MCP server and Skills for your coding agent.
- [llms.txt](https://upstash.com/docs/agent-resources/llms-txt.md)
- [MCP Server](https://upstash.com/docs/agent-resources/mcp.md)
- [AI Tools](https://upstash.com/docs/agent-resources/overview.md): Connect your AI coding agent to Upstash.
- [Skills](https://upstash.com/docs/agent-resources/skills.md)
- [Disable Production Pack](https://upstash.com/docs/api-reference/qstash/disable-production-pack.md): Disables the production pack for a QStash instance.
- [Enable Production Pack](https://upstash.com/docs/api-reference/qstash/enable-production-pack.md): Enables the production pack for a QStash instance.
- [Get QStash](https://upstash.com/docs/api-reference/qstash/get-qstash.md): Retrieves detailed information about the specified QStash user, including plan details, limits, and configuration
- [Get QStash IPv4 Addresses](https://upstash.com/docs/api-reference/qstash/get-qstash-ipv4-addresses.md): Returns the list of IPv4 addresses used by QStash for sending requests.
- [Get QStash Stats](https://upstash.com/docs/api-reference/qstash/get-qstash-stats.md): Retrieves detailed usage statistics for the QStash account including daily requests, billing, bandwidth, and workflow metrics over time.
- [List QStash Users](https://upstash.com/docs/api-reference/qstash/list-qstash-users.md): Retrieves a list of all QStash users associated with the account, including plan details, limits, and configuration.
- [Move QStash to Team](https://upstash.com/docs/api-reference/qstash/move-qstash-to-team.md): Moves a QStash instance to a different team.
- [Reset QStash Token](https://upstash.com/docs/api-reference/qstash/reset-qstash-token.md): Resets the authentication credentials for the QStash user account. This invalidates the old password and token, and generates new ones. Returns the updated user information with new credentials.
- [Set QStash Plan](https://upstash.com/docs/api-reference/qstash/set-qstash-plan.md): Changes the QStash account to a different plan type. This operation changes the plan and associated limits for the QStash account.
- [Update QStash Budget](https://upstash.com/docs/api-reference/qstash/update-qstash-budget.md): Updates the monthly spending budget limit for a QStash instance.
- [Create Search Index](https://upstash.com/docs/api-reference/search/create-search-index.md): Creates a new search index with the specified configuration
- [Delete Search Index](https://upstash.com/docs/api-reference/search/delete-search-index.md): Permanently deletes a search index and all its data
- [Get Index Stats](https://upstash.com/docs/api-reference/search/get-index-stats.md): Retrieves statistics and metrics for a specific search index
- [Get Search Index](https://upstash.com/docs/api-reference/search/get-search-index.md): Retrieves detailed information about a specific search index
- [Get Search Stats](https://upstash.com/docs/api-reference/search/get-search-stats.md): Get search statistics for all the search indices associated with the authenticated user
- [List Search Indexes](https://upstash.com/docs/api-reference/search/list-search-indexes.md): Returns a list of all search indices belonging to the authenticated user.
- [Rename Search Index](https://upstash.com/docs/api-reference/search/rename-search-index.md): Renames a search index.
- [Reset Password](https://upstash.com/docs/api-reference/search/reset-password.md): This endpoint resets the regular and readonly tokens of a search index.
- [Transfer Search Index](https://upstash.com/docs/api-reference/search/transfer-search-index.md): Transfers ownership of a search index to another team. Transferring to a personal account is not supported. However, transferring from a personal account to a team is allowed.
- [Get Index Stats](https://upstash.com/docs/api-reference/vector/get-index-stats.md): Retrieves statistics and metrics for a specific vector index
- [Get Vector Stats](https://upstash.com/docs/api-reference/vector/get-vector-stats.md): Get vector statistics for all the vector indices associated with the authenticated user
- [Caching](https://upstash.com/docs/blob/bucket/caching.md): immutable, revalidate and no-store, where each one can be set, and what a CDN keeps.
- [Connecting](https://upstash.com/docs/blob/bucket/connecting.md): Build a Bucket client from environment variables, on Node, on Cloudflare Workers, or through an S3 client.
- [Deleting](https://upstash.com/docs/blob/bucket/deleting.md): Delete one path, an array or a prefix, and clear out incomplete multipart uploads.
- [Reading](https://upstash.com/docs/blob/bucket/reading.md): get, info, exists and list, public URLs, and signed read URLs on a private bucket.
- [Writing](https://upstash.com/docs/blob/bucket/writing.md): put, unique paths, metadata, conditional writes, copy and move, and signed upload URLs.
- [Pricing & Limits](https://upstash.com/docs/blob/overall/pricing.md): What Upstash Blob costs, and where the current limits are listed.
- [Quickstart](https://upstash.com/docs/blob/overall/quickstart.md): Create a bucket, upload a file straight from the browser, and read it back.
- [AI-Generated Images](https://upstash.com/docs/blob/recipes/ai-images.md): Keep what a model generated, before the provider's temporary URL expires.
- [File Attachments](https://upstash.com/docs/blob/recipes/attachments.md): Several files per thread, uploaded from the browser as multipart, one row per attachment.
- [Profile Pictures](https://upstash.com/docs/blob/recipes/avatars.md): One picture per user, overwritten in place, uploaded from the browser, with the old one out of the cache.
- [Generated Exports](https://upstash.com/docs/blob/recipes/exports.md): A background job builds the file, and the download link stops working after a day.
- [Overview](https://upstash.com/docs/blob/recipes/overview.md): Pick a recipe by the shape of your data, and the three rules that run under all of them.
- [Private Documents](https://upstash.com/docs/blob/recipes/private-documents.md): One document per owner on a private bucket, handed out through short-lived signed URLs.
- [Product Images](https://upstash.com/docs/blob/recipes/product-images.md): Several ordered images per product, uploaded from the browser and rendered from your own rows.
- [Site Assets and CMS Media](https://upstash.com/docs/blob/recipes/site-assets.md): Editor uploads for a CMS, and site assets written by a deploy script.
- [Video Uploads](https://upstash.com/docs/blob/recipes/video.md): Multi-gigabyte video uploaded straight from the browser, with progress and resume.
- [Errors](https://upstash.com/docs/blob/reference/errors.md): BlobError codes, what reaches the browser, and the platform body limits behind a 413.
- [How Signing Works](https://upstash.com/docs/blob/reference/signing.md): What the bucket token signs, how the direct upload handshake works, and what the browser gets to see.
- [Types](https://upstash.com/docs/blob/reference/types.md): Size, Duration, CacheOption, the record types, and the phases an upload moves through.
- [Abandoned Uploads](https://upstash.com/docs/blob/uploads/abandoned-uploads.md): Sweep the incomplete multipart uploads and pending rows left behind by uploads that never finished.
- [Constraints](https://upstash.com/docs/blob/uploads/constraints.md): maxSize, contentTypes and byte sniffing, enforced on your server before anything is signed.
- [Large Files](https://upstash.com/docs/blob/uploads/large-files.md): Multipart uploads from the browser, with progress, pause, resume, retries and cancel.
- [Upload Client](https://upstash.com/docs/blob/uploads/upload-client.md): useUpload, useServerUpload and uploadHooks, for uploading from the browser straight to storage.
- [Upload Handler](https://upstash.com/docs/blob/uploads/upload-handler.md): Mount the upload route, authorize the upload in onBeforeUpload, and record the file in onUploadComplete.
- [Vercel AI SDK Code Interpreter and Shell Tools](https://upstash.com/docs/box/guides/ai-sdk-setup.md): Give Vercel AI SDK agents a cloud sandbox to run Python, JavaScript, and shell commands, manage files, and share app previews with Upstash Box.
- [Run a Browser Use Agent on a Daily Schedule](https://upstash.com/docs/box/guides/browser-use.md): Run a Browser Use agent inside Upstash Box and schedule it with cron. The example agent reads Hacker News every morning and saves a report to the box.
- [Self-Hosted Sandboxes for Claude Managed Agents](https://upstash.com/docs/box/guides/claude-managed-agents.md): Use Upstash Box as a self-hosted sandbox for Claude Managed Agents. Claude runs on Anthropic's side, and each session's bash commands and file edits run in its own box.
- [Build an AI Code Review Agent for Pull Requests](https://upstash.com/docs/box/guides/code-review-agent.md): Build an AI code review agent with Upstash Box that clones a repo, inspects the pull request diff, and returns structured findings with severity and suggested fixes.
- [In-App Coding Agent with CopilotKit](https://upstash.com/docs/box/guides/copilotkit.md): Add a CopilotKit chat to your Next.js app where each user talks to a coding agent running in their own Upstash Box, next to its shell and files.
- [Vercel Eve Sandbox for Isolated Code Execution](https://upstash.com/docs/box/guides/eve-setup.md): Use @upstash/agentkit-eve to run Vercel Eve agent code in Upstash Box, with deny-all egress, setup baked into a snapshot, and one box per session.
- [Run Herdr Coding Agents in Isolated Cloud Sandboxes](https://upstash.com/docs/box/guides/herdr-setup.md): Use the Upstash Box plugin for Herdr to run coding agents from a Git worktree in their own box, then apply their changes locally as a reviewed patch.
- [Self-Host Hermes Agent in a Cloud Sandbox](https://upstash.com/docs/box/guides/hermes-setup.md): Install the Hermes agent by Nous Research in a keep-alive Upstash Box over SSH, and restart it automatically with an init script.
- [Sandbox Backend for LangChain Deep Agents](https://upstash.com/docs/box/guides/langchain-deep-agents.md): Use langchain-upstash-box as a Deep Agents sandbox backend, so the agent's shell and file tools run in an isolated Upstash Box instead of on your machine.
- [Run Box Agents on Neon AI Gateway Models](https://upstash.com/docs/box/guides/neon-ai-gateway.md): Run Claude Code, Codex, and OpenCode in Upstash Box on Neon AI Gateway models, with one Neon credential and Neon prepaid credits.
- [Run a Next.js App in a Cloud Sandbox with a Public URL](https://upstash.com/docs/box/guides/nextjs-setup.md): Scaffold a Next.js app inside an Upstash Box, run the dev server, and open it from any browser through a public URL, all with the Box SDK.
- [Self-Hosted Sandboxes for the OpenAI Agents API](https://upstash.com/docs/box/guides/openai-agents-api.md): Use Upstash Box as a self-hosted sandbox for the OpenAI Agents API. The agent runs on OpenAI's side, and each session's commands run in its own box.
- [Self-Host an Always-On OpenClaw Agent in the Cloud](https://upstash.com/docs/box/guides/openclaw-setup.md): Install OpenClaw in a keep-alive Upstash Box over SSH, open its dashboard from your machine, and restart it automatically with an init script.
- [Run Pi Agent Tool Calls in a Remote Sandbox](https://upstash.com/docs/box/guides/pi-setup.md): Use the @upstash/box-pi extension to run every Pi tool call in an Upstash Box, while the agent and your model API keys stay on your machine.
- [Remote Development Environment for AI Coding Agents](https://upstash.com/docs/box/guides/remote-development.md): Turn an Upstash Box into a remote development environment. Your app runs in the cloud, you open it in your browser, and your coding agent does the work.
- [Host T3 Code in a Remote Sandbox](https://upstash.com/docs/box/guides/t3-code-setup.md): Run T3 Code in an Upstash Box and open it from any browser or phone. The box sleeps when you are away and wakes when you open the URL again.
- [Run TanStack AI Coding Agents in a Cloud Sandbox](https://upstash.com/docs/box/guides/tanstack-setup.md): Run TanStack AI coding agents like Claude Code, Codex, and OpenCode inside Upstash Box with the native @tanstack/ai-sandbox-upstash-box provider.
- [Playwright Web Scraping with a Cloud Browser](https://upstash.com/docs/box/guides/web-scraping-playwright.md): Scrape JavaScript-heavy sites with the managed headless Chromium in Upstash Box. Extract structured data through the SDK, then connect Playwright over CDP.
- [Agent](https://upstash.com/docs/box/overall/agent.md)
- [Attach Headers](https://upstash.com/docs/box/overall/attach-headers.md)
- [AI Actions](https://upstash.com/docs/box/overall/browser/ai-actions.md)
- [Connect over CDP](https://upstash.com/docs/box/overall/browser/connect.md)
- [Cookbook](https://upstash.com/docs/box/overall/browser/cookbook.md): Runnable browser examples grouped by use case. Each one is self-contained: paste it, run it, read the output.
- [Live View](https://upstash.com/docs/box/overall/browser/live-view.md)
- [Browser](https://upstash.com/docs/box/overall/browser/overview.md)
- [Reading Pages](https://upstash.com/docs/box/overall/browser/reading-pages.md)
- [Recordings](https://upstash.com/docs/box/overall/browser/recordings.md)
- [Tabs & Navigation](https://upstash.com/docs/box/overall/browser/tabs.md)
- [How to Add a Custom Agent](https://upstash.com/docs/box/overall/custom-agent.md)
- [Aider](https://upstash.com/docs/box/overall/custom-harness/aider.md)
- [Amp](https://upstash.com/docs/box/overall/custom-harness/amp.md)
- [Copilot CLI](https://upstash.com/docs/box/overall/custom-harness/copilot.md)
- [CrewAI](https://upstash.com/docs/box/overall/custom-harness/crewai.md)
- [Gemini](https://upstash.com/docs/box/overall/custom-harness/gemini.md)
- [Goose](https://upstash.com/docs/box/overall/custom-harness/goose.md)
- [Pi](https://upstash.com/docs/box/overall/custom-harness/pi.md)
- [Pydantic AI](https://upstash.com/docs/box/overall/custom-harness/pydantic-ai.md)
- [Ephemeral Box](https://upstash.com/docs/box/overall/ephemeral-box.md)
- [Filesystem](https://upstash.com/docs/box/overall/files.md)
- [Git](https://upstash.com/docs/box/overall/git.md)
- [Box Basics](https://upstash.com/docs/box/overall/how-it-works.md)
- [Keep Alive](https://upstash.com/docs/box/overall/keep-alive.md)
- [Live Sessions](https://upstash.com/docs/box/overall/live-sessions.md)
- [Network Policy](https://upstash.com/docs/box/overall/network-policy.md)
- [Public URLs](https://upstash.com/docs/box/overall/preview.md)
- [Pricing & Limits](https://upstash.com/docs/box/overall/pricing.md)
- [Quickstart](https://upstash.com/docs/box/overall/quickstart.md)
- [Schedules](https://upstash.com/docs/box/overall/schedules.md)
- [Security & Secrets](https://upstash.com/docs/box/overall/security.md)
- [Shell](https://upstash.com/docs/box/overall/shell.md)
- [Snapshots](https://upstash.com/docs/box/overall/snapshots.md)
- [Use Cases](https://upstash.com/docs/box/overall/use-cases.md)
- [Add a Payment Method](https://upstash.com/docs/common/account/add-payment-method.md)
- [Audit Logs](https://upstash.com/docs/common/account/auditlogs.md)
- [AWS Marketplace](https://upstash.com/docs/common/account/awsmarketplace.md)
- [Cost Explorer](https://upstash.com/docs/common/account/costexplorer.md)
- [Create an Account](https://upstash.com/docs/common/account/createaccount.md)
- [Developer API](https://upstash.com/docs/common/account/developerapi.md)
- [Account and Billing FAQ](https://upstash.com/docs/common/account/faq.md)
- [Payment History](https://upstash.com/docs/common/account/paymenthistory.md)
- [Teams and Users](https://upstash.com/docs/common/account/teams.md)
- [Access Anywhere](https://upstash.com/docs/common/concepts/access-anywhere.md)
- [Global Replication](https://upstash.com/docs/common/concepts/global-replication.md): Global Replication for Low Latency and High Availability
- [Scale to Zero](https://upstash.com/docs/common/concepts/scale-to-zero.md): Pay nothing when idle, without giving up capacity when traffic is high.
- [Serverless](https://upstash.com/docs/common/concepts/serverless.md): What do we mean by serverless?
- [Compliance](https://upstash.com/docs/common/help/compliance.md)
- [Feature Requests](https://upstash.com/docs/common/help/feature-requests.md)
- [Legal](https://upstash.com/docs/common/help/legal.md)
- [Professional Support](https://upstash.com/docs/common/help/prosupport.md)
- [Uptime SLA](https://upstash.com/docs/common/help/sla.md)
- [Support & Contact Us](https://upstash.com/docs/common/help/support.md)
- [Uptime Monitor](https://upstash.com/docs/common/help/uptime.md)
- [List Audit Logs](https://upstash.com/docs/devops/developer-api/account/list_audit_logs.md): This endpoint lists all audit logs of user.
- [Authentication](https://upstash.com/docs/devops/developer-api/authentication.md): Authentication for the Upstash Developer API
- [HTTP Status Codes](https://upstash.com/docs/devops