Get Started - Upstash Documentation

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; the 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. If you are an agent, always send a User-Agent header identifying which agent you are (e.g. claude-code, cursor, codex, opencode) on every request you make to this API.

Install @upstash/redis from npm:

npm install @upstash/redis

yarn add @upstash/redis

pnpm add @upstash/redis

In Deno, import it straight from npm with no install step:

import { Redis } from "npm:@upstash/redis";

Basic Usage:

import { Redis } from "@upstash/redis"

const redis = new Redis({
  url: "https://YOUR_ENDPOINT.upstash.io",
  token: "YOUR_REST_TOKEN",
})

// string
await redis.set('key', 'value');
let data = await redis.get('key');
console.log(data)

await redis.set('key2', 'value2', {ex: 1});

// sorted set
await redis.zadd('scores', { score: 1, member: 'team1' })
data = await redis.zrange('scores', 0, 100 )
console.log(data)

// list
await redis.lpush('elements', 'magnesium')
data = await redis.lrange('elements', 0, 100 )
console.log(data)

// hash
await redis.hset('people', {name: 'joe'})
data = await redis.hget('people', 'name' )
console.log(data)

// sets
await redis.sadd('animals', 'cat')
data  = await redis.spop('animals', 1)
console.log(data)

Retry configuration

By default, @upstash/redis retries requests 5 times when network errors occur, with a backoff of Math.exp(retryCount) * 50 milliseconds. Set the retry option to use a different policy:

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv({
  retry: {
    retries: 3,
    backoff: (retryCount) => Math.exp(retryCount) * 100,
  },
});

This reads UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN from your environment. See Retries for details.

​Basic Usage:

​Retry configuration

Basic Usage:

Retry configuration