KV

Plate-KV is a Redis-compatible HTTP API server that provides REST-like access to key-value data operations. Each [id] is an isolated namespace, so multiple applications or environments can share one server without colliding keys.

Base URL

[base-url]/[id]/...

All endpoints require a [id] path parameter.

Request Styles

Plate-KV supports two API styles:

• Wrapper endpoints are the preferred modern HTTP interface.
• Command endpoints remain available for backward compatibility and advanced Redis-compatible access.

Wrapper Endpoints

Wrapper endpoints use descriptive URLs and typed JSON bodies.

Example:

POST /[id]/hashes/set
{
  "key": "user:1",
  "value": {
    "name": "Ada",
    "age": 30
  }
}

Command Endpoints

Command endpoints use a Redis-style request payload:

{
  "command": "SET",
  "args": ["mykey", "hello world"]
}

Response Format

Success responses use a consistent envelope:

{
  "ok": true,
  "data": {
    "result": "OK"
  }
}

Error responses use:

{
  "ok": false,
  "error": {
    "code": "invalid_request",
    "message": "human readable message"
  }
}

API Categories