LICENSE Documentation

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.

Docs Copy Chapter

• README
• CLI
• llms.txt
• MCP Server
• Skills
• Disable Production Pack: Disables the production pack for a QStash instance.
• Enable Production Pack: Enables the production pack for a QStash instance.
• Get QStash: Retrieves detailed information about the specified QStash user, including plan details, limits, and configuration
• Get QStash IPv4 Addresses: Returns the list of IPv4 addresses used by QStash for sending requests.
• Get QStash Stats: Retrieves detailed usage statistics for the QStash account including daily requests, billing, bandwidth, and workflow metrics over time.
• List QStash Users: Retrieves a list of all QStash users associated with the account, including plan details, limits, and configuration.
• Move QStash to Team: Moves a QStash instance to a different team.
• Reset QStash Token: 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: Changes the QStash account to a different plan type. This operation changes the plan and associated limits for the QStash account.
• Update QStash Budget: Updates the monthly spending budget limit for a QStash instance.
• Create Search Index: Creates a new search index with the specified configuration
• Delete Search Index: Permanently deletes a search index and all its data
• Get Index Stats: Retrieves statistics and metrics for a specific search index
• Get Search Index: Retrieves detailed information about a specific search index
• Get Search Stats: Get search statistics for all the search indices associated with the authenticated user
• List Search Indexes: Returns a list of all search indices belonging to the authenticated user.
• Rename Search Index: Renames a search index.
• Reset Password: This endpoint resets the regular and readonly tokens of a search index.
• Transfer Search Index: 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: Retrieves statistics and metrics for a specific vector index
• Get Vector Stats: Get vector statistics for all the vector indices associated with the authenticated user
• Code Interpreter with Vercel AI SDK
• Build a Code Review Agent
• Running Tests with Crabbox
• Hermes Setup
• LangChain Deep Agents
• Next.js Setup
• OpenClaw Setup
• Pi Setup
• Remote Development
• AI File Editor with TanStack AI
• Scrape Dynamic Websites with Playwright
• Agent
• Attach Headers
• AI Actions
• Connect over CDP
• Cookbook: Runnable browser examples grouped by use case. Each one is self-contained: paste it, run it, read the output.
• Live View
• Browser
• Reading Pages
• Recordings
• Tabs & Navigation
• How to Add a Custom Agent
• Aider
• CrewAI
• Gemini
• Goose
• Pi
• Pydantic AI
• Ephemeral Box
• Filesystem
• Git
• Box Basics
• Keep Alive
• Network Policy
• Public URLs
• Pricing & Limits
• Quickstart
• Schedules
• Security & Secrets
• Shell
• Snapshots
• Use Cases
• Add a Payment Method
• Audit Logs
• AWS Marketplace
• Cost Explorer
• Create an Account
• Developer API
• Account and Billing FAQ
• Payment History
• Teams and Users
• Access Anywhere
• Global Replication: Global Replication for Low Latency and High Availability
• Scale to Zero: Only pay for what you really use.
• Serverless: What do we mean by serverless?
• Account & Teams
• Announcements: Upstash Announcements!
• Compliance
• Legal
• Production Checklist
• Professional Support
• Uptime SLA
• Support & Contact Us
• Uptime Monitor
• List Audit Logs: This endpoint lists all audit logs of user.
• Authentication: Authentication for the Upstash Developer API
• HTTP Status Codes: The Upstash API uses the following HTTP Status codes:
• Getting Started
• Create Backup: This endpoint creates a backup for a Redis database.
• Delete Backup: This endpoint deletes a backup of a Redis database.
• Disable Daily Backup: This endpoint disables daily backup for a Redis database.
• Enable Daily Backup: This endpoint enables daily backup for a Redis database.
• List Backup: This endpoint lists all backups for a Redis database.
• Restore Backup: This endpoint restores data from an existing backup.
• Change Database Plan: This endpoint changes the plan of a Redis database.
• Create Redis Database: This endpoint creates a new Redis database.
• Delete Database: This endpoint deletes a database.
• Disable Auto Upgrade: This endpoint disables Auto Upgrade for given database.
• Disable Eviction: This endpoint disables eviction for given database.
• Enable Auto Upgrade: This endpoint enables Auto Upgrade for given database.
• Enable Eviction: This endpoint enables eviction for given database.
• Enable TLS: This endpoint enables tls on a database.
• Get Database: This endpoint gets details of a database.
• Get Database Stats: This endpoint gets detailed stats of a database.
• List Databases: This endpoint list all databases of user.
• Move To Team: This endpoint moves database under a target team
• Rename Database: This endpoint renames a database.
• Reset Password: This endpoint updates the password of a database.
• Update Database Budget: This endpoint updates the monthly budget of a Redis database.
• Update Regions: Update the regions of a database
• Add Team Member: This endpoint adds a new team member to the specified team.
• Create Team: This endpoint creates a new team.
• Delete Team: This endpoint deletes a team.
• Delete Team Member: This endpoint deletes a team member from the specified team.
• Get Team Members: This endpoint list all members of a team.
• List Teams: This endpoint lists all teams of user.
• Create Index: This endpoint creates an index.
• Delete Index: This endpoint deletes an index.
• Get Index: This endpoint returns the data associated to a index.
• List Indices: This endpoint returns the data related to all indices of an account as a list.
• Rename Index: This endpoint is used to change the name of an index.
• Reset Index Passwords: This endpoint is used to reset regular and readonly tokens of an index.
• Set Index Plan: This endpoint is used to change the plan of an index.
• Transfer Index: This endpoint is used to transfer an index to another team. Transferring to a personal account is not supported. However, transferring an index from a personal account to a team is allowed.
• Overview
• Terraform
• upstash_qstash_endpoint_data
• upstash_qstash_schedule_data
• upstash_qstash_topic_data
• upstash_redis_database_data
• upstash_team_data
• Overview
• upstash_qstash_endpoint: Create and manage QStash endpoints.
• upstash_qstash_schedule: Create and manage QStash schedules.
• upstash_qstash_topic: Create and manage QStash topics
• upstash_redis_database: Create and manage Upstash Redis databases.
• upstash_team: Create and manage teams on Upstash.
• Bg color codes
• Get Started: Serverless data and messaging for developers: Redis, Vector, QStash, Workflow, Search, and Box, with SDKs, integrations, and a full-featured console.
• Bulk Delete DLQ messages: Delete multiple messages from the DLQ
• Bulk Retry DLQ messages: Retry delivery of multiple messages from the DLQ
• Delete a DLQ message: Manually remove a message from the DLQ
• Get a DLQ message: Get a specific message from the DLQ
• List DLQ messages: List and paginate through all messages currently in the DLQ
• Retry a DLQ message: Retry delivery of a message from the DLQ
• Get Flow Control Key: Get details of a specific Flow Control key
• Get Global Parallelism: Returns the current global parallelism usage across all flow control keys
• List Flow Control Keys: List all Flow Control keys
• Pause Flow Control Key: Pauses the delivery of messages associated with a specific flow-control key.
• Pin Configuration for Flow Control Key: Pins a processing configuration for a specific flow-control key.
• Reset Rate for Flow Control Key: Resets the rate configuration state for a specific flow-control key.
• Resume Flow Control Key: Resumes the delivery of messages associated with a specific flow-control key.
• Unpin Configuration for Flow Control Key: Removes the pinned configuration for a specific flow-control key.
• List Logs: Paginate through logs of published messages
• Batch Messages: Send multiple messages in a single request
• Bulk Cancel Messages: Delete all pending messages
• Cancel a Message: Cancel a pending message
• Enqueue a Message: Enqueue a message to the specified queue
• Get a Message: Retrieve details of a specific message
• Publish a Message: Publish a message to the specified destination
• Delete a queue: Deletes a queue
• Get a Queue: Get details of a specific queue
• List Queues: List all your queues
• Pause Queue: Pause a queue to stop the delivery of enqueued messages
• Resume Queue: Resumes a queue to starts the delivery of enqueued messages
• Upsert a Queue: Updates or creates a queue
• Create a Schedule: Create a schedule to send messages periodically
• Delete a Schedule: Delete a schedule
• Get a Schedule: Get details of a specific schedule
• List schedules: List all schedules
• Pause a Schedule: Pause a Schedule
• Resume a Schedule: Resume a paused Schedule
• Get Signing Keys: Retrieve your current and next signing keys
• Rotate Signing Keys: Rotate your signing keys
• Delete a URL Group: Delete a topic and all its endpoints
• Get a URL Group: Retrieve details of a specific URL Group
• List URL Groups: List all your URL Groups
• Remove Endpoints: Remove one or more endpoints from a URL Group
• Upsert URL Group and Endpoint: Add an endpoint to a URL Group
• API Rate Limit Response: This page documents the rate limiting behavior of our API and explains how to handle different types of rate limit errors.
• Authentication: Authentication for the QStash API
• At-Least-Once Delivery
• Background Jobs
• Batching
• Callbacks
• Deduplication
• Delay
• Dead Letter Queues
• Flow Control
• Queues
• Retry
• Schedules
• Security
• URL Groups
• Debug Logs
• Delete Schedules
• Handling Failures
• Local Development
• Local Tunnel
• Select a Region
• Publish Messages
• Read-only Token
• Receiving Messages: What do we send to your API?
• Redact Private Data: How to redact private data in your messages
• Reset Token
• Roll Your Signing Keys
• Verify Signatures
• Create URL Groups and Endpoints
• Use as Webhook Receiver
• LLM with Anthropic
• Datadog - Upstash QStash Integration
• LLM - OpenAI
• n8n with QStash
• Pipedream: Build and run workflows with 1000s of open source triggers and actions across 900+ apps.
• Prometheus - Upstash QStash Integration
• Email - Resend
• Development Server License Agreement
• API Examples
• Changelog
• Compare
• Prod Pack & Enterprise
• Getting Started
• llms.txt
• Pricing & Limits
• Roadmap
• Use Cases
• AWS Lambda (Node)
• AWS Lambda (Python)
• Cloudflare Workers
• Deno Deploy
• Golang
• Python on Vercel
• Next.js
• Periodic Data Updates
• DLQ
• Events
• Flow Control
• Keys
• Messages
• Overview
• Publish
• Queues
• Receiver
• Schedules
• URL Groups
• Getting Started
• Overview
• DLQ
• Flow Control
• Logs
• Messages
• Overview
• Publish
• Queues
• Receiver
• Schedules
• URL Groups
• Getting Started
• Overview
• Channels
• Client-Side Usage
• History
• Authentication
• Server-Side Usage
• Deployment
• Pricing
• Quickstart
• BITCOUNT: Count set bits in a string.
• BITFIELD: Perform arbitrary bitfield operations.
• BITFIELD_RO: Read bitfield values.
• BITOP: Perform bitwise operations between strings.
• BITPOS: Find first bit set or clear in a string.
• GETBIT: Get the bit value at offset.
• Bitmap commands: Commands for manipulating individual bits and bit fields in string values.
• SETBIT: Set or clear the bit at offset.
• AUTH: Authenticate to the server.
• CLIENT GETNAME: Get the current connection name.
• CLIENT ID: Get the current client ID.
• CLIENT INFO: Get info about current connection.
• CLIENT LIST: List all client connections.
• CLIENT SETINFO: Set client connection attributes.
• CLIENT SETNAME: Set the connection name.
• ECHO: Echo the given string.
• HELLO: Handshake with Redis protocol.
• Connection commands: Commands for authenticating, inspecting, and managing client connections.
• PING: Ping the server.
• QUIT: Close the connection.
• RESET: Reset the connection.
• SELECT: Select the database by index.
• FCALL: Call a function.
• FCALL_RO: Call a read-only function.
• FUNCTION DELETE: Delete a library.
• FUNCTION FLUSH: Delete all libraries.
• FUNCTION KILL: Kill a running function.
• FUNCTION LIST: List all libraries.
• FUNCTION LOAD: Load a library.
• FUNCTION STATS: Get function execution stats.
• Functions commands: Commands for loading, managing, and invoking Redis functions.
• COPY: Copy a key to another key.
• DEL: Delete one or more keys.
• DUMP: Serialize a key's value.
• EXISTS: Check if keys exist.
• EXPIRE: Set a key's TTL in seconds.
• EXPIREAT: Set expiry as Unix timestamp.
• EXPIRETIME: Get expiry as Unix timestamp.
• KEYS: Find keys matching a pattern.
• MEMORY USAGE: Estimate memory used by a key.
• Generic commands: Commands for managing keys, expiration, serialization, and database-wide key operations.
• PERSIST: Remove the expiration from a key.
• PEXPIRE: Set a key's TTL in milliseconds.
• PEXPIREAT: Set expiry as Unix ms timestamp.
• PEXPIRETIME: Get expiry as Unix ms timestamp.
• PTTL: Get TTL in milliseconds.
• RANDOMKEY: Return a random key.
• RENAME: Rename a key.
• RENAMENX: Rename a key if new key doesn't exist.
• RESTORE: Deserialize and restore a key.
• SCAN: Incrementally iterate keys.
• TOUCH: Update last access time of keys.
• TTL: Get TTL in seconds.
• TYPE: Get the type of a key.
• UNLINK: Delete keys asynchronously.
• WAIT: Wait for replica acknowledgements.
• WAITAOF: Wait for local and replica persistence.
• GEOADD: Add geospatial items.
• GEODIST: Get distance between two members.
• GEOHASH: Get geohash strings for members.
• GEOPOS: Get coordinates of members.
• GEORADIUS: Find members within a radius of a point.
• GEORADIUS_RO: Find members within a radius of a point.
• GEORADIUSBYMEMBER: Find members within a radius of another member.
• GEORADIUSBYMEMBER_RO: Find members within a radius of another member.
• GEOSEARCH: Search for members in an area.
• GEOSEARCHSTORE: Store geosearch results.
• Geo commands: Commands for storing and querying geospatial data.
• HDEL: Delete one or more hash fields.
• HEXISTS: Check if a hash field exists.
• HEXPIRE: Set field TTL in seconds.
• HEXPIREAT: Set field expiry as timestamp.
• HEXPIRETIME: Get field expiry as timestamp.
• HGET: Get the value of a hash field.
• HGETALL: Get all fields and values.
• HGETDEL: Get and delete hash fields.
• HGETEX: Get fields and set their expiry.
• HINCRBY: Increment integer value of a field.
• HINCRBYFLOAT: Increment float value of a field.
• HKEYS: Get all fields in a hash.
• HLEN: Get number of fields in a hash.
• HMGET: Get values of multiple fields.
• HMSET: Set multiple hash fields.
• HPERSIST: Remove field expiration.
• HPEXPIRE: Set field TTL in milliseconds.
• HPEXPIREAT: Set field expiry as ms timestamp.
• HPEXPIRETIME: Get field expiry as ms timestamp.
• HPTTL: Get field TTL in milliseconds.
• HRANDFIELD: Get random fields from a hash.
• HSCAN: Incrementally iterate hash fields.
• HSET: Set hash field values.
• HSETEX: Set fields with expiration.
• HSETNX: Set field only if it doesn't exist.
• HSTRLEN: Get length of a field's value.
• HTTL: Get field TTL in seconds.
• HVALS: Get all values in a hash.
• Hash commands: Commands for storing and manipulating field-value collections.
• HyperLogLog commands: Commands for probabilistic cardinality estimation.
• PFADD: Add elements to HyperLogLog.
• PFCOUNT: Get estimated cardinality.
• PFMERGE: Merge multiple HyperLogLogs.
• JSON.ARRAPPEND: Append values to JSON array.
• JSON.ARRINDEX: Find index of value in array.
• JSON.ARRINSERT: Insert values into JSON array.
• JSON.ARRLEN: Get JSON array length.
• JSON.ARRPOP: Pop value from JSON array.
• JSON.ARRTRIM: Trim JSON array to range.
• JSON.CLEAR: Clear JSON values.
• JSON.DEBUG: Inspect JSON memory usage.
• JSON.DEL: Delete JSON values.
• JSON.FORGET: Delete JSON values (alias of JSON.DEL).
• JSON.GET: Get JSON values.
• JSON.MERGE: Merge JSON values.
• JSON.MGET: Get values from multiple keys.
• JSON.MSET: Set values in multiple keys.
• JSON.NUMINCRBY: Increment JSON number.
• JSON.NUMMULTBY: Multiply JSON number.
• JSON.OBJKEYS: Get JSON object keys.
• JSON.OBJLEN: Get JSON object size.
• JSON.RESP: Get JSON in RESP format.
• JSON.SET: Set JSON value.
• JSON.STRAPPEND: Append to JSON string.
• JSON.STRLEN: Get JSON string length.
• JSON.TOGGLE: Toggle JSON boolean.
• JSON.TYPE: Get JSON value type.
• JSON commands: Commands for storing and manipulating JSON values.
• BLMOVE: Move an element between lists, blocking until one arrives.
• BLMPOP: Pop from the first non-empty list, blocking until one arrives.
• BLPOP: Pop from the head of a list, blocking until an element arrives.
• BRPOP: Pop from the tail of a list, blocking until an element arrives.
• BRPOPLPUSH: Pop from a list's tail and push it to another, blocking until an element arrives.
• LINDEX: Get element by index.
• LINSERT: Insert before or after pivot.
• LLEN: Get list length.
• LMOVE: Move element between lists.
• LMPOP: Pop from the first non-empty list.
• LPOP: Pop from list head.
• LPOS: Find the position of an element.
• LPUSH: Push to list head.
• LPUSHX: Push to head if list exists.
• LRANGE: Get range of elements.
• LREM: Remove elements by value.
• LSET: Set element at index.
• LTRIM: Trim list to range.
• List commands: Commands for storing and manipulating ordered collections.
• RPOP: Pop from list tail.
• RPOPLPUSH: Pop from tail and push to head.
• RPUSH: Push to list tail.
• RPUSHX: Push to tail if list exists.
• Redis command reference: Browse the Redis commands supported by Upstash, organized by category.
• Pub/Sub commands: Commands for publishing messages and managing channel subscriptions.
• PSUBSCRIBE: Subscribe to pattern channels.
• PUBLISH: Publish message to channel.
• PUBSUB: Inspect pub/sub state.
• PUNSUBSCRIBE: Unsubscribe from patterns.
• SUBSCRIBE: Subscribe to channels.
• UNSUBSCRIBE: Unsubscribe from channels.
• EVAL: Execute a Lua script.
• EVAL_RO: Execute read-only Lua script.
• EVALSHA: Execute cached Lua script by SHA.
• EVALSHA_RO: Run a cached script that does not write.
• Scripting commands: Commands for loading and executing Lua scripts.
• SCRIPT EXISTS: Check if scripts exist in cache.
• SCRIPT FLUSH: Clear the script cache.
• SCRIPT KILL: Stop a running read-only script.
• SCRIPT LOAD: Load script into cache.
• Search commands: Commands for creating, querying, and managing Upstash Redis Search indexes.
• SEARCH.AGGREGATE: Compute analytics over matching documents.
• SEARCH.ALIASADD: Create or update a search index alias.
• SEARCH.ALIASDEL: Delete a search index alias.
• SEARCH.COUNT: Count documents matching a query.
• SEARCH.CREATE: Create a search index.
• SEARCH.DESCRIBE: Return metadata about a search index.
• SEARCH.DROP: Drop a search index without deleting its keys.
• SEARCH.LISTALIASES: List search index aliases.
• SEARCH.LISTINDEXES: List search indexes in the database.
• SEARCH.QUERY: Search documents with a JSON filter.
• SEARCH.REINDEX: Rebuild a search index from the current matching data.
• SEARCH.WAITINDEXING: Wait until pending index updates are visible.
• ACL CAT: List command categories.
• ACL DELUSER: Delete one or more ACL users.
• ACL GENPASS: Generate a cryptographically strong random password.
• ACL GENTOKEN: Generate a REST token that can be used as a SETUSER password.
• ACL GETUSER: Get the user's details.
• ACL LIST: Show users details in config file format.
• ACL LOAD: Reload ACL definitions from the primary node.
• ACL LOG: Show the ACL log entries.
• ACL RESTTOKEN: Generate a REST token for an existing user.
• ACL SAVE: Push ACL definitions to replica nodes.
• ACL SETUSER: Create or modify a user with the specified attributes.
• ACL USERS: List all the registered usernames.
• ACL WHOAMI: Return the current connection username.
• COMMAND: Get command metadata.
• CONFIG GET: Read runtime configuration.
• CONFIG SET: Change runtime configuration.
• DBSIZE: Get number of keys in database.
• FLUSHALL: Delete all keys in all databases.
• FLUSHDB: Delete all keys in current database.
• INFO: Get server statistics and information.
• MONITOR: Stream all commands received.
• Server commands: Commands for inspecting and managing the Redis server.
• TIME: Get current server time.
• Set commands: Commands for storing and manipulating unordered collections of unique members.
• SADD: Add members to a set.
• SCARD: Get set cardinality.
• SDIFF: Get set difference.
• SDIFFSTORE: Store set difference.
• SINTER: Get set intersection.
• SINTERCARD: Get intersection cardinality.
• SINTERSTORE: Store set intersection.
• SISMEMBER: Check if member exists in set.
• SMEMBERS: Get all set members.
• SMISMEMBER: Check membership of several values.
• SMOVE: Move member between sets.
• SPOP: Remove and return random members.
• SRANDMEMBER: Get random members.
• SREM: Remove members from a set.
• SSCAN: Incrementally iterate set members.
• SUNION: Get set union.
• SUNIONSTORE: Store set union.
• BZMPOP: Pop from the first non-empty sorted set, blocking until one arrives.
• BZPOPMAX: Pop the highest-scoring member, blocking until one arrives.
• BZPOPMIN: Pop the lowest-scoring member, blocking until one arrives.
• Sorted Set commands: Commands for storing and manipulating scored collections.
• ZADD: Add members with scores.
• ZCARD: Get sorted set cardinality.
• ZCOUNT: Count members in score range.
• ZDIFF: Get sorted set difference.
• ZDIFFSTORE: Store sorted set difference.
• ZINCRBY: Increment member's score.
• ZINTER: Get sorted set intersection.
• ZINTERCARD: Get intersection cardinality.
• ZINTERSTORE: Store sorted set intersection.
• ZLEXCOUNT: Count members in lex range.
• ZMPOP: Pop from the first non-empty sorted set.
• ZMSCORE: Get scores of multiple members.
• ZPOPMAX: Pop members with highest scores.
• ZPOPMIN: Pop members with lowest scores.
• ZRANDMEMBER: Get random members.
• ZRANGE: Get members by index, score, or lex range.
• ZRANGEBYLEX: Get members by lex range.
• ZRANGEBYSCORE: Get members by score range.
• ZRANGESTORE: Store the result of a range query.
• ZRANK: Get member's rank.
• ZREM: Remove members.
• ZREMRANGEBYLEX: Remove members by lex range.
• ZREMRANGEBYRANK: Remove members by rank range.
• ZREMRANGEBYSCORE: Remove members by score range.
• ZREVRANGE: Get members in reverse order.
• ZREVRANGEBYLEX: List members in a lexicographic range, in reverse order.
• ZREVRANGEBYSCORE: List members in a score range, highest score first.
• ZREVRANK: Get member's reverse rank.
• ZSCAN: Incrementally iterate sorted set.
• ZSCORE: Get member's score.
• ZUNION: Get sorted set union.
• ZUNIONSTORE: Store sorted set union.
• Streams commands: Commands for append-only logs, consumer groups, and message processing.
• XACK: Acknowledge stream messages.
• XACKDEL: Acknowledge and delete messages.
• XADD: Add entry to stream.
• XAUTOCLAIM: Auto-claim idle messages.
• XCLAIM: Claim pending messages.
• XDEL: Delete stream entries.
• XDELEX: Delete entries with reference control.
• XGROUP: Manage consumer groups.
• XINFO CONSUMERS: List group consumers.
• XINFO GROUPS: List stream groups.
• XINFO STREAM: Get stream info.
• XLEN: Get stream length.
• XPENDING: Get pending messages info.
• XRANGE: Get range of stream entries.
• XREAD: Read stream entries.
• XREADGROUP: Read as consumer group.
• XREVRANGE: Get range in reverse order.
• XTRIM: Trim stream to max length.
• APPEND: Append value to a string.
• DECR: Decrement integer value by 1.
• DECRBY: Decrement integer by amount.
• DELEX: Delete a string when a condition matches.
• DIGEST: Get the digest of a string value.
• GET: Get string value.
• GETDEL: Get value and delete key.
• GETEX: Get value and set expiration.
• GETRANGE: Get substring of string.
• GETSET: Set value and return old value.
• INCR: Increment integer value by 1.
• INCRBY: Increment integer by amount.
• INCRBYFLOAT: Increment float by amount.
• MGET: Get values of multiple keys.
• MSET: Set multiple keys at once.
• MSETNX: Set multiple keys if none exist.
• String commands: Commands for storing and manipulating string values.
• PSETEX: Set value with ms expiration.
• SET: Set string value.
• SETEX: Set value with expiration.
• SETNX: Set value if key doesn't exist.
• SETRANGE: Overwrite part of string.
• STRLEN: Get string length.
• DISCARD: Discard queued commands.
• EXEC: Execute queued commands.
• MULTI: Start a transaction.
• Transactions commands: Commands for grouping operations into atomic transactions.
• UNWATCH: Unwatch all keys.
• WATCH: Watch keys for changes.
• Auto Upgrade
• Backup/Restore
• Consistency
• Credential Protection
• Durable Storage: This article explains the persistence provided by Upstash databases.
• Eviction
• Global Database
• Key-Based Locking: Key-based locks for concurrent command execution
• Replication
• REST API: Access your Upstash Redis database over HTTP, from serverless and edge runtimes where TCP connections are restricted.
• Security
• Compliance
• Frequently Asked Questions
• Integration with Third Parties & Partnerships
• Legal
• Managing Healthcare Data
• Production Checklist
• Shared Responsibility Model
• Support & Contact Us
• Uptime Monitor
• Connect Your Client
• Connect with @upstash/redis
• Datadog - Upstash Redis Integration
• EMQX - Upstash Redis Integration
• Get Started with AWS Lambda
• Get Started with Cloudflare Workers
• Get Started with Google Cloud Functions
• Import/Export Data
• ioredis note
• Use IP Allowlist
• Listen Keyspace Notifications
• Metrics and Charts
• Migrate Regional to Global Database
• Monitor your usage
• Read Your Writes
• Using redis-cli: Connect to your Upstash Redis database with redis-cli. Learn how to install it, connect over TLS, run commands, and when to use TCP versus HTTP.
• Terraform Provider
• Upgrade Your Database
• Vercel - Upstash Redis Integration
• BullMQ with Upstash Redis
• Celery with Upstash Redis
• DrizzleORM with Upstash Redis
• n8n with Upstash Redis
• Prometheus - Upstash Redis Integration
• Configure Upstash Ratelimit Strapi Plugin
• Upstash Ratelimit Strapi Integration
• Replit Templates
• Sidekiq with Upstash Redis
• Pricing & Billing: How Upstash Redis pricing works — free tier, Pay-As-You-Go, and Fixed plans, with current limits and billing details.
• Changelog
• Compare
• Redis® API Compatibility: supported commands, modules, and protocols
• Prod Pack & Enterprise
• Getting Started: Create an Upstash Redis database in seconds
• llms.txt
• Pricing & Limits
• Pricing & Limits
• Python SDK
• Rate Limit SDK
• Typescript SDK
• Use Cases
• AWS Lambda
• Azure Functions
• Cloudflare Workers
• Deno Deploy
• DigitalOcean
• Django
• Elixir: Tutorial on Using Upstash Redis In Your Phoenix App and Deploying it on Fly.
• FastAPI
• Fastly
• Flask
• Fly.io
• Google Cloud Run functions
• ioredis note
• Koyeb
• Laravel
• App Router
• Pages Router
• AWS Lambda
• SST
• Supabase Functions
• App Router
• Pages Router
• Vercel Python Runtime
• Agent Analytics
• Vercel AI SDK Memory, RAG & Chat History with Redis: Add long-term memory, RAG, and chat history to the Vercel AI SDK with Upstash Redis — drop-in tools for generateText and streamText, no separate vector database.
• Vercel AI SDK Memory, RAG & Chat History with Redis: Add long-term memory, RAG, and chat history to the Vercel AI SDK with Upstash Redis — drop-in tools for generateText and streamText, no separate vector database.
• Memory, Chat History, RAG, Rate Limiting & Sandboxes for the Vercel Eve Agent Framework: Add long-term memory, searchable chat history, RAG, rate limiting, tool caching, and sandboxes to Vercel's Eve agent framework with Upstash Redis — no separate vector database.
• Memory, Chat History, RAG, Rate Limiting & Sandboxes for the Vercel Eve Agent Framework: Add long-term memory, searchable chat history, RAG, rate limiting, tool caching, and sandboxes to Vercel's Eve agent framework with Upstash Redis — no separate vector database.
• Upstash Redis MCP
• ECHO
• PING: Send a ping to the server and get a response if the server is alive.
• BITCOUNT: Count the number of set bits.
• BITFIELD: Sets or gets parts of a bitfield
• BITOP: Perform bitwise operations between strings.
• BITPOS: Find the position of the first set or clear bit (bit with a value of 1 or 0) in a Redis string key.
• GETBIT: Retrieve a single bit.
• SETBIT: Set a single bit in a string.
• CLIENT SETINFO: Set client library name and version information.
• DEL: Removes the specified keys. A key is ignored if it does not exist.
• EXISTS: Check if a key exists.
• EXPIRE: Sets a timeout on key. The key will automatically be deleted.
• EXPIREAT: Sets a timeout on key. The key will automatically be deleted.
• KEYS: Returns all keys matching pattern.
• PERSIST: Remove any timeout set on the key.
• PEXPIRE: Sets a timeout on key. After the timeout has expired, the key will automatically be deleted.
• PEXPIREAT: Sets a timeout on key. After the timeout has expired, the key will automatically be deleted.
• PTTL: Return the expiration in milliseconds of a key.
• RANDOMKEY: Returns a random key from database
• RENAME: Rename a key
• RENAMENX: Rename a key if it does not already exist.
• SCAN: Scan the database for keys.
• TOUCH: Alters the last access time of one or more keys
• TTL: Return the expiration in seconds of a key.
• TYPE: Get the type of a key.
• UNLINK: Removes the specified keys. A key is ignored if it does not exist.
• HDEL: Deletes one or more hash fields.
• HEXISTS: Checks if a field exists in a hash.
• HEXPIRE: Set a timeout on a hash field in seconds.
• HEXPIREAT: Sets an expiration time for field(s) in a hash in seconds since the Unix epoch.
• HEXPIRETIME: Retrieves the expiration time of field(s) in a hash in seconds.
• HGET: Retrieves the value of a hash field.
• HGETALL: Retrieves all fields from a hash.
• HGETDEL: Get and delete hash fields atomically.
• HGETEX: Get hash fields with expiration support.
• HINCRBY: Increments the value of a hash field by a given amount
• HINCRBYFLOAT: Increments the value of a hash field by a given float value.
• HKEYS: Return all field names in the hash stored at key.
• HLEN: Returns the number of fields contained in the hash stored at key.
• HMGET: Return the requested fields and their values.
• HMSET: Write multiple fields to a hash.
• HPERSIST: Remove the expiration from one or more hash fields.
• HPEXPIRE: Set a timeout on a hash field in milliseconds.
• HPEXPIREAT: Sets an expiration time for field(s) in a hash in milliseconds since the Unix epoch.
• HPEXPIRETIME: Retrieves the expiration time of a field in a hash in milliseconds.
• HPTTL: Retrieves the remaining time-to-live (TTL) for field(s) in a hash in milliseconds.
• HRANDFIELD: Return a random field from a hash
• HSCAN: Scan a hash for fields.
• HSET: Write one or more fields to a hash.
• HSETEX: Set hash fields with expiration support.
• HSETNX: Write a field to a hash but only if the field does not exist.
• HSTRLEN: Returns the string length of a value in a hash.
• HTTL: Retrieves the remaining time-to-live (TTL) for field(s) in a hash in seconds.
• HVALS: Returns all values in the hash stored at key.
• JSON.ARRAPPEND: Append values to the array at path in the JSON document at key.
• JSON.ARRINDEX: Search for the first occurrence of a JSON value in an array.
• JSON.ARRINSERT: Insert the json values into the array at path before the index (shifts to the right).
• JSON.ARRLEN: Report the length of the JSON array at path in key.
• JSON.ARRPOP: Remove and return an element from the index in the array. By default the last element from an array is popped.
• JSON.ARRTRIM: Trim an array so that it contains only the specified inclusive range of elements.
• JSON.CLEAR: Clear container values (arrays/objects) and set numeric values to 0.
• JSON.DEL: Delete a key from a JSON document.
• JSON.FORGET: Delete a key from a JSON document.
• JSON.GET: Get a single value from a JSON document.
• JSON.MERGE: Merges the JSON value at path in key with the provided value.
• JSON.MGET: Get the same path from multiple JSON documents.
• JSON.MSET: Sets multiple JSON values at multiple paths in multiple keys.
• JSON.NUMINCRBY: Increment the number value stored at path by number.
• JSON.NUMMULTBY: Multiply the number value stored at path by number.
• JSON.OBJKEYS: Return the keys in the object that`s referenced by path.
• JSON.OBJLEN: Report the number of keys in the JSON object at path in key.
• JSON.RESP: Return the value at the path in Redis serialization protocol format.
• JSON.SET: Set the JSON value at path in key.
• JSON.STRAPPEND: Append the json-string values to the string at path.
• JSON.STRLEN: Report the length of the JSON String at path in key
• JSON.TOGGLE: Toggle a boolean value stored at path.
• JSON.TYPE: Report the type of JSON value at path.
• LINDEX: Returns the element at index index in the list stored at key.
• LINSERT: Insert an element before or after another element in a list
• LLEN: Returns the length of the list stored at key.
• LMOVE: Move an element from one list to another.
• LPOP: Remove and return the first element(s) of a list
• LPOS: Returns the index of matching elements inside a list.
• LPUSH: Push an element at the head of the list.
• LPUSHX: Push an element at the head of the list only if the list exists.
• LRANGE: Returns the specified elements of the list stored at key.
• LREM: Remove the first count occurrences of an element from a list.
• LSET: Set a value at a specific index.
• LTRIM: Trim a list to the specified range
• RPOP: Remove and return the last element(s) of a list
• RPUSH: Push an element at the end of the list.
• RPUSHX: Push an element at the end of the list only if the list exists.
• Overview: Available Commands in upstash-redis
• PUBLISH: Publish a message to a channel
• EVAL: Evaluate a Lua script server side.
• EVAL_RO: Evaluate a read-only Lua script server side.
• EVALSHA: Evaluate a cached Lua script server side.
• EVALSHA_RO: Evaluate a cached read-only Lua script server side.
• SCRIPT EXISTS: Check if scripts exist in the script cache.
• SCRIPT FLUSH: Removes all scripts from the script cache.
• SCRIPT LOAD: Load the specified Lua script into the script cache.
• DBSIZE: Count the number of keys in the database.
• FLUSHALL
• FLUSHDB
• SADD: Adds one or more members to a set.
• SCARD: Return how many members are in a set
• SDIFF: Return the difference between sets
• SDIFFSTORE: Write the difference between sets to a new set
• SINTER: Return the intersection between sets
• SINTER: Return the intersection between sets and store the resulting set in a key
• SISMEMBER: Check if a member exists in a set
• SMEMBERS: Return all the members of a set
• SMISMEMBER: Check if multiple members exist in a set
• SMOVE: Move a member from one set to another
• SPOP: Removes and returns one or more random members from a set.
• SRANDMEMBER: Returns one or more random members from a set.
• SREM: Remove one or more members from a set
• SSCAN: Scan a set
• SUNION: Return the union between sets
• SUNIONSTORE: Return the union between sets and store the resulting set in a key
• XACK: Removes one or multiple messages from the pending entries list of a stream consumer group.
• XACKDEL: Acknowledge and delete stream entries atomically.
• XADD: Appends one or more new entries to a stream.
• XAUTOCLAIM: Changes the ownership of pending messages from one consumer to another in a stream consumer group automatically.
• XCLAIM: Changes the ownership of pending messages from one consumer to another in a stream consumer group.
• XDEL: Removes the specified entries from a stream, and returns the number of entries deleted.
• XDELEX: Extended delete for streams with reference control.
• XGROUP CREATE: Create a new consumer group for a Redis stream.
• XGROUP CREATECONSUMER: Create a new consumer in an existing consumer group.
• XGROUP DELCONSUMER: Delete a consumer from a consumer group.
• XGROUP DESTROY: Delete an entire consumer group.
• XGROUP SETID: Set the last delivered ID for a consumer group.
• XINFO CONSUMERS: List all consumers in a consumer group.
• XINFO GROUPS: List all consumer groups for a stream.
• XLEN: Returns the number of entries inside a stream.
• XPENDING: Returns information about pending messages in a stream consumer group.
• XRANGE: Returns stream entries matching a given range of IDs.
• XREAD: Reads data from one or multiple streams, starting from the specified IDs.
• XREADGROUP: Reads data from a stream as part of a consumer group.
• XREVRANGE: Returns stream entries matching a given range of IDs in reverse order.
• XTRIM: Trims the stream by removing entries to keep it at a reasonable size.
• APPEND: Append a value to a string stored at key.
• DECR: Decrement the integer value of a key by one
• DECRBY: Decrement the integer value of a key by a given number.
• GET: Return the value of the specified key or None if the key doesn't exist.
• GETDEL: Return the value of the specified key and delete the key.
• GETRANGE: Return a substring of value at the specified key.
• GETSET: Return the value of the specified key and replace it with a new value.
• INCR: Increment the integer value of a key by one
• INCRBY: Increment the integer value of a key by a given number.
• INCRBYFLOAT: Increment the float value of a key by a given number.
• MGET: Load multiple keys from Redis in one go.
• MSET: Set multiple keys in one go.
• MSETNX: Set multiple keys in one go unless they exist already.
• SET: Set a key to hold a string value.
• SETRANGE: Writes the value of key at offset.
• STRLEN: Return the length of a string stored at a key.
• ZADD: Add a member to a sorted set, or update its score if it already exists.
• ZCARD: Returns the number of elements in the sorted set stored at key.
• ZCOUNT: Returns the number of elements in the sorted set stored at key filterd by score.
• ZDIFF: Returns the difference between sets.
• ZDIFFSTORE: Writes the difference between sets to a new key.
• ZINCRBY: Increment the score of a member.
• ZINTER: Returns the intersection between sets.
• ZINTERSTORE: Calculates the intersection of sets and stores the result in a key
• ZLEXCOUNT: Returns the number of elements in the sorted set stored at key filterd by lex.
• ZMSCORE: Returns the scores of multiple members.
• ZPOPMAX: Removes and returns up to count members with the highest scores in the sorted set stored at key.
• ZPOPMIN: Removes and returns up to count members with the lowest scores in the sorted set stored at key.
• ZRANDMEMBER: Returns one or more random members from a sorted set, optionally with their scores.
• ZRANGE: Returns the specified range of elements in the sorted set stored at key.
• ZRANK: Returns the rank of a member
• ZREM: Remove one or more members from a sorted set
• ZREMRANGEBYLEX: Remove all members in a sorted set between the given lexicographical range.
• ZREMRANGEBYRANK: Remove all members in a sorted set between the given ranks.
• ZREMRANGEBYSCORE: Remove all members in a sorted set between the given scores.
• ZREVRANK: Returns the rank of a member in a sorted set, with scores ordered from high to low.
• ZSCAN: Scan a sorted set
• ZSCORE: Returns the scores of a member.
• ZINTER: Returns the intersection between sets.
• ZUNIONSTORE: Writes the union between sets to a new key.
• Features
• Getting Started
• Overview
• Ratelimiting Algorithms
• Features
• Getting Started
• Overview
• Ratelimiting Algorithms
• Costs
• Features
• Getting Started
• Configure Upstash Ratelimit Strapi Plugin
• Upstash Ratelimit Strapi Integration
• Methods
• Overview
• Traffic Protection
• Realtime
• Redis Analytics
• Advanced
• ECHO
• PING: Send a ping to the server and get a response if the server is alive.
• BITCOUNT: Count the number of set bits.
• BITOP: Perform bitwise operations between strings.
• BITPOS: Find the position of the first set or clear bit (bit with a value of 1 or 0) in a Redis string key.
• GETBIT: Retrieve a single bit.
• SETBIT: Set a single bit in a string.
• CLIENT SETINFO: Set client library name and version information.
• FCALL: Invoke a function.
• FCALL_RO: Invoke a read-only function
• FUNCTION DELETE: Delete a library and all its functions.
• FUNCTION FLUSH: Delete all the libraries and functions.
• FUNCTION LIST: List details about the registered libraries and functions.
• FUNCTION LOAD: Load a library to Redis.
• FUNCTION STATS: Return information about the function running engine.
• DEL: Removes the specified keys. A key is ignored if it does not exist.
• EXISTS: Check if a key exists.
• EXPIRE: Sets a timeout on key. The key will automatically be deleted.
• EXPIREAT: Sets a timeout on key. The key will automatically be deleted.
• KEYS: Returns all keys matching pattern.
• PERSIST: Remove any timeout set on the key.
• PEXPIRE: Sets a timeout on key. After the timeout has expired, the key will automatically be deleted.
• PEXPIREAT: Sets a timeout on key. After the timeout has expired, the key will automatically be deleted.
• PTTL: Return the expiration in milliseconds of a key.
• RANDOMKEY: Returns a random key from database
• RENAME: Rename a key
• RENAMENX: Rename a key if it does not already exist.
• SCAN: Scan the database for keys.
• TOUCH: Alters the last access time of one or more keys
• TTL: Return the expiration in seconds of a key.
• TYPE: Get the type of a key.
• UNLINK: Removes the specified keys. A key is ignored if it does not exist.
• HDEL: Deletes one or more hash fields.
• HEXISTS: Checks if a field exists in a hash.
• HEXPIRE: Sets an expiration time for one or more fields in a hash.
• HEXPIREAT: Sets an expiration time for field(s) in a hash in seconds since the Unix epoch.
• HEXPIRETIME: Retrieves the expiration time of field(s) in a hash in seconds.
• HGET: Retrieves the value of a hash field.
• HGETALL: Retrieves all fields from a hash.
• HGETDEL: Get and delete hash fields atomically.
• HGETEX: Get hash fields with expiration support.
• HINCRBY: Increments the value of a hash field by a given amount
• HINCRBYFLOAT: Increments the value of a hash field by a given float value.
• HKEYS: Return all field names in the hash stored at key.
• HLEN: Returns the number of fields contained in the hash stored at key.
• HMGET: Return the requested fields and their values.
• HPERSIST: Remove the expiration from one or more fields in a hash.
• HPEXPIRE: Sets an expiration time for a field in a hash in milliseconds.
• HPEXPIREAT: Sets an expiration time for field(s) in a hash in milliseconds since the Unix epoch.
• HPEXPIRETIME: Retrieves the expiration time of a field in a hash in milliseconds.
• HPTTL: Retrieves the remaining time-to-live (TTL) for field(s) in a hash in milliseconds.
• HRANDFIELD: Return a random field from a hash
• HSCAN: Scan a hash for fields.
• HSET: Write one or more fields to a hash.
• HSETEX: Set hash fields with expiration support.
• HSETNX: Write a field to a hash but only if the field does not exist.
• HSTRLEN: Returns the string length of a value in a hash.
• HTTL: Retrieves the remaining time-to-live (TTL) for field(s) in a hash in seconds.
• HVALS: Returns all values in the hash stored at key.
• JSON.ARRAPPEND: Append values to the array at path in the JSON document at key.
• JSON.ARRINDEX: Search for the first occurrence of a JSON value in an array.
• JSON.ARRINSERT: Insert the json values into the array at path before the index (shifts to the right).
• JSON.ARRLEN: Report the length of the JSON array at path in key.
• JSON.ARRPOP: Remove and return an element from the index in the array. By default the last element from an array is popped.
• JSON.ARRTRIM: Trim an array so that it contains only the specified inclusive range of elements.
• JSON.CLEAR: Clear container values (arrays/objects) and set numeric values to 0.
• JSON.DEL: Delete a key from a JSON document.
• JSON.FORGET: Delete a key from a JSON document.
• JSON.GET: Get a single value from a JSON document.
• JSON.MERGE: Merges the JSON value at path in key with the provided value.
• JSON.MGET: Get the same path from multiple JSON documents.
• JSON.MSET: Sets multiple JSON values at multiple paths in multiple keys.
• JSON.NUMINCRBY: Increment the number value stored at path by number.
• JSON.NUMMULTBY: Multiply the number value stored at path by number.
• JSON.OBJKEYS: Return the keys in the object that`s referenced by path.
• JSON.OBJLEN: Report the number of keys in the JSON object at path in key.
• JSON.SET: Set the JSON value at path in key.
• JSON.STRAPPEND: Append the json-string values to the string at path.
• JSON.STRLEN: Report the length of the JSON String at path in key
• JSON.TOGGLE: Toggle a boolean value stored at path.
• JSON.TYPE: Report the type of JSON value at path.
• LINDEX: Returns the element at index index in the list stored at key.
• LINSERT: Insert an element before or after another element in a list
• LLEN: Returns the length of the list stored at key.
• LMOVE: Move an element from one list to another.
• LPOP: Remove and return the first element(s) of a list
• LPOS: Returns the index of matching elements inside a list.
• LPUSH: Push an element at the head of the list.
• LPUSHX: Push an element at the head of the list only if the list exists.
• LRANGE: Returns the specified elements of the list stored at key.
• LREM: Remove the first count occurrences of an element from a list.
• LSET: Set a value at a specific index.
• LTRIM: Trim a list to the specified range
• RPOP: Remove and return the last element(s) of a list
• RPUSH: Push an element at the end of the list.
• RPUSHX: Push an element at the end of the list only if the list exists.
• Overview: Available Commands in @upstash/redis
• PSUBSCRIBE: Subscribe to a channel by patterns/wildcards
• PUBLISH: Publish a message to a channel
• SUBSCRIBE: Subscribe to a channel
• EVAL: Evaluate a Lua script server side.
• EVAL_RO: Evaluate a read-only Lua script server side.
• EVALSHA: Evaluate a cached Lua script server side.
• EVALSHA_RO: Evaluate a cached read-only Lua script server side.
• SCRIPT EXISTS: Check if scripts exist in the script cache.
• SCRIPT FLUSH: Removes all scripts from the script cache.
• SCRIPT LOAD: Load the specified Lua script into the script cache.
• DBSIZE: Count the number of keys in the database.
• FLUSHALL
• FLUSHDB
• SADD: Adds one or more members to a set.
• SCARD: Return how many members are in a set
• SDIFF: Return the difference between sets
• SDIFFSTORE: Write the difference between sets to a new set
• SINTER: Return the intersection between sets
• SINTERSTORE: Return the intersection between sets and store the resulting set in a key
• SISMEMBER: Check if a member exists in a set
• SMEMBERS: Return all the members of a set
• SMISMEMBER: Check if multiple members exist in a set
• SMOVE: Move a member from one set to another
• SPOP: Removes and returns one or more random members from a set.
• SRANDMEMBER: Returns one or more random members from a set.
• SREM: Remove one or more members from a set
• SSCAN: Scan a set
• SUNION: Return the union between sets
• SUNIONSTORE: Return the union between sets and store the resulting set in a key
• XACK: Removes one or multiple messages from the pending entries list of a stream consumer group.
• XACKDEL: Acknowledge and delete stream entries atomically.
• XADD: Appends one or more new entries to a stream.
• XAUTOCLAIM: Changes the ownership of pending messages from one consumer to another in a stream consumer group.
• XCLAIM: Changes the ownership of pending messages from one consumer to another in a stream consumer group.
• XDEL: Removes the specified entries from a stream, and returns the number of entries deleted.
• XDELEX: Extended delete for streams with reference control.
• XGROUP: Manage consumer groups for Redis streams.
• XINFO: Returns information about streams, consumer groups, and consumers.
• XLEN: Returns the number of entries inside a stream.
• XPENDING: Returns information about pending messages in a stream consumer group.
• XRANGE: Returns stream entries matching a given range of IDs.
• XREAD: Reads data from one or multiple streams, starting from the specified IDs.
• XREADGROUP: Reads data from a stream as part of a consumer group.
• XREVRANGE: Returns stream entries matching a given range of IDs in reverse order.
• XTRIM: Trims the stream by removing entries to keep it at a reasonable size.
• String Commands
• APPEND: Append a value to a string stored at key.
• DECR: Decrement the integer value of a key by one
• DECRBY: Decrement the integer value of a key by a given number.
• GET: Return the value of the specified key or null if the key doesn't exist.
• GETDEL: Return the value of the specified key and delete the key.
• GETRANGE: Return a substring of value at the specified key.
• GETSET: Return the value of the specified key and replace it with a new value.
• INCR: Increment the integer value of a key by one
• INCRBY: Increment the integer value of a key by a given number.
• INCRBYFLOAT: Increment the float value of a key by a given number.
• MGET: Load multiple keys from Redis in one go.
• MSET: Set multiple keys in one go.
• MSETNX: Set multiple keys in one go unless they exist already.
• SET: Set a key to hold a string value.
• SETRANGE: Writes the value of key at offset.
• STRLEN: Return the length of a string stored at a key.
• Transactions: Transactions
• ZADD: Add a member to a sorted set, or update its score if it already exists.
• ZCARD: Returns the number of elements in the sorted set stored at key.
• ZCOUNT: Returns the number of elements in the sorted set stored at key filterd by score.
• ZDIFFSTORE: Writes the difference between sets to a new key.
• ZINCRBY: Increment the score of a member.
• ZINTERSTORE: Writes the intersection between sets to a new key.
• ZLEXCOUNT: Returns the number of elements in the sorted set stored at key filtered by lex.
• ZMSCORE: Returns the scores of multiple members.
• ZPOPMAX: Removes and returns up to count members with the highest scores in the sorted set stored at key.
• ZPOPMIN: Removes and returns up to count members with the lowest scores in the sorted set stored at key.
• ZRANGE: Returns the specified range of elements in the sorted set stored at key.
• ZRANK: Returns the rank of a member
• ZREM: Remove one or more members from a sorted set
• ZREMRANGEBYLEX: Remove all members in a sorted set between the given lexicographical range.
• ZREMRANGEBYRANK: Remove all members in a sorted set between the given ranks.
• ZREMRANGEBYSCORE: Remove all members in a sorted set between the given scores.
• ZREVRANK: Returns the rank of a member in a sorted set, with scores ordered from high to low.
• ZSCAN: Scan a sorted set
• ZSCORE: Returns the scores of a member.
• ZUNIONSTORE: Writes the union between sets to a new key.
• Deployment
• Developing or Testing
• Get Started
• Overview
• Auto-Pipelining
• Pipeline & Transaction
• Retries
• Troubleshooting
• ioredis: Use Redis Search with ioredis via the @upstash/search-ioredis adapter
• node-redis: Use Redis Search with node-redis via the @upstash/search-redis adapter
• $dateHistogram
• $facet
• $histogram
• Overview
• $range
• $terms
• $avg
• $cardinality
• $count
• $extendedStats
• $max
• $min
• Overview
• $percentiles
• $stats
• $sum
• Aggregations
• Aliases
• Command Reference: Browse the commands supported by Upstash Redis Search.
• Counting
• Document Updates
• Quickstart
• Indices
• Introduction
• $boost
• $must
• $mustNot
• Overview
• $should
• $boost
• $eq
• $fuzzy
• $in
• Overview
• $phrase
• Range Operators
• $regex
• Smart Matching
• Queries
• Blog Search
• E-commerce Search
• Overview
• User Directory
• Schemas
• Troubleshooting
• Unexpected Increase in Command Count
• ERR DB capacity quota exceeded
• Error read ECONNRESET
• WRONGPASS invalid or missing auth token
• ERR max concurrent connections exceeded
• ERR max daily request limit exceeded
• ERR max key size exceeded
• ERR max single record size exceeded
• ERR max request size exceeded
• ERR max requests limit exceeded
• NOAUTH Authentication Required
• Connecting with Read-Only Access
• ERR XReadGroup is cancelled
• Agent Memory with Redis Search: Build short-term and long-term memory for AI agents on Upstash Redis. Store working memory with TTLs and recall long-term memories with Redis Search full-text queries.
• Deploy a Serverless API with AWS CDK and AWS Lambda
• Autocomplete API with Serverless Redis
• Build Stateful Applications with AWS App Runner and Serverless Redis: This tutorial shows how to create a serverless and stateful application using AWS App Runner and Redis
• Session Management on Google Cloud Run with Serverless Redis: This tutorial shows how to manage user sessions on Google Cloud Run using Serverless Redis.
• Cloudflare Workers with Websockets and Redis
• Use Redis in Cloudflare Workers
• Backendless Coin Price List with GraphQL API, Serverless Redis and Next.JS
• Build a Leaderboard API At Edge using Cloudflare Workers and Redis: This tutorial shows how to build a Leaderboard API At Edge using Cloudflare Workers and Redis.
• Express Session with Serverless Redis: This tutorial shows how to use Upstash as the session storage of your Express application.
• Serverless Golang API with Redis
• Build a Serverless Histogram API with Redis: This tutorial shows how to build a histogram API with Redis.
• Job Processing and Event Queue with Serverless Redis: This tutorial shows how to use Upstash Redis for job/task processing.
• Caching in Laravel with Redis
• Next.js with Redis
• Building a Serverless Notification API for Your Web Application with Redis: This tutorial shows how to create a Serverless Notification API for Your Web Application with Redis.
• Nuxt with Redis: This tutorial shows how to use Upstash inside your Nuxt application.
• Redis as a Cache for Your FastAPI App
• Multithreaded Web Scraping with Redis Caching
• Rate Limiting for Your FastAPI App
• Build a Real-Time Chat Application with Serverless Redis
• Manage Sessions in Python with Serverless Redis
• Building a URL Shortener with Redis
• Serverless Python API with Redis
• AWS Lambda Rate Limiting with Serverless Redis
• Redis Queue: From FIFO Lists to a Job Queue: How to build FIFO, reliable, and blocking queues on Upstash Redis, then a delayed and prioritized job queue with a dead-letter queue.
• Serverless Redisson: This tutorial shows how to use Upstash with Redisson client.
• Roadmap Voting App with Serverless Redis: This is a single page application powered by upstash and next.js.
• Serverless API with Java and Redis
• TanStack AI Chat Persistance: Use Upstash Redis to persist TanStack AI chat histories across reloads, navigation, and devices with a simple adapter.
• Using AWS SAM
• Serverless Redis on Google Cloud Run functions
• Using Serverless Framework
• Advanced Settings
• Algorithm
• Content and Metadata: How to use content and metadata fields in your documents
• Filtering
• Indexes
• Reranking
• FAQ: Questions And Answers About Upstash Search
• Docusaurus Integration: AI-powered search component for Docusaurus using Upstash Search.
• Getting Started: Creating an Upstash Search Database
• Pricing & Limits
• What is Upstash Search?: Lightweight, AI-powered search for developers
• Delete
• Fetch
• Info
• Range
• Reset
• Search
• Upsert
• Getting Started
• Delete
• Fetch
• Info
• Range
• Reset
• Search
• Upsert
• Contributing
• Getting Started
• Database Migrator: a CLI tool to migrate your data to Upstash Search
• Documentation Crawler: A tool to crawl docs and feed Upstash Search database
• Docs Search Quickstart: Add Upstash Search to your website in minutes
• Next.js Search Quickstart: Getting Started With Upstash Search and Next.js
• SearchBar: A beautifully-designed, accessible search component for React
• Delete Vectors: Deletes the vectors with the given ids.
• Delete Namespace: Deletes a namespace of an index.
• Fetch Vectors: Fetches the vectors with the provided ids.
• Fetch Random Vector: Fetches a random vector.
• Index Info: Returns some information about the index.
• List Namespaces: Lists the names of the namespaces of an index.
• Query Vectors: Queries the approximate nearest neighbors of a vector.
• Query Data: Queries the approximate nearest neighbors of a raw text data after embedding it.
• Range Vectors: Ranges over vectors starting(inclusive) from a cursor until the end of the vectors in the or given limit.
• Rename Namespace: Renames a namespace of an index.
• Reset Namespace(s): Resets one or all namespaces of an index to its initial state by deleting all the vectors.
• Resume: Resumes a previously started query to fetch additional results.
• Start with Data: Perform queries using text data that can be resumed to fetch additional results.
• Start with Vector: Perform queries that can be resumed to fetch additional results.
• Stop Resumable Query: Ends a resumable query and releases associated resources.
• Update Vector: Updates a vector, data or metadata.
• Upsert Vectors: Upserts (inserts or updates) the vector.
• Upsert Data: Upserts (inserts or updates) the raw text data after embedding it.
• Getting Started
• Examples
• Algorithm
• Embedding Models
• Metadata Filtering
• Hybrid Indexes
• Metadata and Data
• Namespaces
• Resumable Query
• Vector Similarity Functions
• Sparse Indexes
• FAQ
• Vercel AI SDK with Upstash Vector
• Flowise with Upstash Vector and Redis
• LangChain with Upstash Vector
• Langflow with Upstash Vector
• LlamaIndex with Upstash Vector
• LlamaParse with Upstash Vector
• Changelog
• Compare
• Getting Started
• llms.txt
• Pricing & Limits
• What is Upstash Vector?
• Go SDK
• Semantic Cache JS
• Semantic Cache Python
• Deleting Vectors
• Fetching Vectors
• Info
• Querying Vectors
• Reset
• Upserting Data with Embedding Models
• Upserting Vectors
• Getting Started
• Getting Started with Laravel
• Delete
• Fetch
• Info
• Query
• Range
• Reset
• Resumable Query
• Update
• Upsert
• Features
• Getting Started
• Advanced
• Delete
• Fetch
• Info
• Query
• Range
• Reset
• Resumable Query
• Upsert
• Contributing
• Getting Started
• Create and Deploy RAG Applications with Gradio
• Use Hugging Face Embeddings with Upstash Vector
• Implement Semantic Search with LangChain
• RAG with LlamaIndex
• Parsing and Querying Documents with LlamaParse
• Simple Semantic Search
• Examples
• Features
• Getting Started
• Overview
• Evaluator-Optimizer
• Orchestrator-Workers
• Parallelization
• Prompt Chaining
• Bulk Delete Failed Workflow Runs: Delete multiple failed workflow runs from the DLQ.
• Bulk Restart Workflows from DLQ: Restart multiple failed workflow runs from the DLQ. Each workflow will start from the beginning.
• Bulk Resume Workflows from DLQ: When a workflow run fails, it's automatically moved to the DLQ (Dead Letter Queue) where it can be analyzed and resumed. The resume feature allows you to continue a failed workflow run from exactly where it failed, without re-executing successfully completed steps.
• Cancel In-Progress Failure Callback: Cancel an in-progress failure callback for a failed workflow.
• Delete Failed Workflow Run: Delete a specific failed workflow run from the DLQ.
• Get Failed Workflow Run: Get details of a specific failed workflow run from the DLQ.
• List Failed Workflow Runs: List and paginate through all failed workflow runs currently in the DLQ.
• Restart Workflow from DLQ: Restart a failed workflow run from the DLQ. The workflow will start from the beginning.
• Resume Workflow from DLQ
• Retry Failure Callback: If the failure callback for a workflow run has failed, you can use this endpoint to manually trigger the failure callback again. This is useful for ensuring that your system is notified of workflow failures even if the original callback attempt did not succeed.
• Get Flow Control Key: Get details of a specific Flow Control key
• Get Flow Control Key: Get details of a specific Flow Control key.
• Get Global Parallelism: Returns the current global parallelism usage across all flow control keys
• List Flow Control Keys: List all Flow Control keys
• Pause Flow Control Key: Pauses the delivery of messages associated with a specific flow-control key.
• Pin Configuration for Flow Control Key: Pins a processing configuration for a specific flow-control key.
• Reset Rate for Flow Control Key: Resets the rate configuration state for a specific flow-control key.
• Resume Flow Control Key: Resumes the delivery of messages associated with a specific flow-control key.
• Unpin Configuration for Flow Control Key: Removes the pinned configuration for a specific flow-control key.
• List Workflow Run Logs
• List Waiters: List all active waiters for a specific event ID.
• Notify Event: Notify an event to all waiters listening for that event ID.
• Notify Workflow Run Event: Notify an event to a specific workflow run's waiters.
• Batch Trigger Workflow Runs: Start multiple workflow runs in a single request.
• Bulk Cancel Workflow Runs: Cancel all matching workflow runs.
• Cancel Workflow Run: Cancel an ongoing workflow run.
• Trigger Workflow Run: Start a new workflow run.
• Get Signing Keys: Retrieve your current and next signing keys
• Rotate Signing Keys: Rotate your signing keys
• Caveats
• Overview
• client.cancel
• client.dlq.retryFailureFunction
• client.dlq.delete
• client.dlq.list
• client.dlq.restart
• client.dlq.resume
• client.logs
• client.notify
• client.trigger
• client.getWaiters
• How Workflow Works
• Overview
• Advanced Options
• Changelog
• AI Generation
• Auth Provider Webhook
• Custom Retry Logic
• Customer Onboarding
• Dynamic Workflows
• E-commerce Order Fulfillment
• Image Processing
• Payment Retries
• Waiting for Events
• Overview
• Rerun Failure Function
• Delete
• Restart
• Resume
• Overview
• Advanced failureUrl Option
• Reliability of Failure Function
• Overview
• Monitor & Manage
• Parallelism
• Rate and Period
• Overview
• Using Serve Many
• Notify
• Parallel Steps
• Overview
• Prevent Retries
• Sleep
• Wait
• Overview
• Webhooks
• Overview
• Cancel a Run
• Update a Workflow
• Configure a Run
• Handle Failed Runs
• Flow control
• Get your QStash Token
• Development Server
• Local Tunnel
• Middlewares
• Migration Guide
• Select a Region
• Parallel Runs
• Read-only Token
• Realtime Quickstart
• Human-in-the-Loop
• Redact Private Data: How to redact private data in your workflow runs
• Schedule a Workflow
• Secure a Workflow
• Start a Run
• Webhooks
• Vercel AI SDK
• Anthropic
• Datadog - Upstash QStash Integration
• OpenAI
• Prometheus - Upstash QStash Integration
• Resend
• llms.txt
• Pricing
• Astro
• Cloudflare Workers
• Express.js
• FastAPI
• Flask
• Hono
• Next.js & FastAPI
• Next.js & Flask
• Nuxt
• Supported Platforms
• SolidJS
• SvelteKit
• TanStack Start
• Next.js
• Roadmap
• JavaScript SDK
• Python SDK
• Overview
• context.api
• context.call
• context.cancel
• context.createWebhook
• context.invoke
• context.notify
• context.run
• context.sleep
• context.sleepUntil
• context.waitForEvent
• context.waitForWebhook
• General
• Vercel

OpenAPI Specs Copy Chapter

• openapi