JSON.RESP - Upstash Documentation

Use JSON.RESP to get a JSON value in RESP form instead of as JSON text. The document is translated structurally: an object becomes an array whose first element is { followed by alternating field names and values, an array becomes an array whose first element is [ followed by its elements, and scalars become the corresponding RESP types. Nested values are translated the same way, recursively. This lets a client walk the structure using the protocol types it already decodes, without running a JSON parser on the reply. For ordinary use, JSON.GET is the more convenient command.

Syntax

JSON.RESP <key> [path]

Arguments

Argument	Required	Repeatable	Description
`key`	Yes	No	JSON document key.
`path`	No	No	Path to convert; defaults to the root.

Important points

Raw TCP examples pass JSON values as valid JSON text. Typed Upstash SDK helpers serialize native objects and values for you.
Paths beginning with $ use JSONPath and can match multiple values, so many JSON commands return an array of per-match results.

Response

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Nested array, Integer, Bulk string, Simple string (`true` or `false` for JSON booleans), or Null bulk string or null array
RESP3	Nested array, Integer, Bulk string, Simple string (`true` or `false` for JSON booleans), or Null

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

JSON.RESP profile $

@upstash/redis

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

const redis = Redis.fromEnv();
const result = await redis.json.resp("profile", "$");
console.log(result);

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.json().resp("profile", "$")
print(result)

ioredis

import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.call("JSON.RESP", "profile", "$");
console.log(result);

node-redis

import { createClient } from "redis";

const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.sendCommand(["JSON.RESP", "profile", "$"]);
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.json().resp("profile", "$")
print(result)

go-redis

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/redis/go-redis/v9"
)

func main() {
    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))
    if err != nil {
        panic(err)
    }
    client := redis.NewClient(opts)
    result, err := client.Do(context.Background(), "JSON.RESP", "profile", "$").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}

jedis

import java.net.URI;
import java.nio.charset.StandardCharsets;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.commands.ProtocolCommand;

ProtocolCommand command = () -> "JSON.RESP".getBytes(StandardCharsets.UTF_8);
try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.sendCommand(command, "profile", "$");
  System.out.println(result);
}

redis-rs

fn main() -> redis::RedisResult<()> {
    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");
    let client = redis::Client::open(url)?;
    let mut connection = client.get_connection()?;

    let mut command = redis::cmd("JSON.RESP");
    command.arg("profile");
    command.arg("$");
    let result: redis::Value = command.query(&mut connection)?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples