RKX API Studio Docs
RKX API Studio Docs

Caching

Free Features · RKX API Studio 1.0.0

Configure the cache

Open Settings and enable response caching, then choose an available TTL. The default is 300 seconds. Cached results include pagination information; X-RKX-API-Studio-Cache reports HIT or MISS when caching is enabled. Use the cache clearing control after a configuration or content change when checking results.

  1. Open RKX API Studio → Settings → Tools.
  2. Find the cache settings card, enable response caching and choose an available TTL.
  3. Wait for the cache card’s update confirmation; its toggle and TTL changes save directly.
  4. Request the endpoint twice and inspect X-RKX-API-Studio-Cache for MISS then HIT.
  5. Use the clear-cache control when checking changed content or configuration.

Understand invalidation

The cache manager invalidates on supported post changes, status transitions/deletion and term changes/deletion. External HTTP caches may retain previously served public responses until their TTL expires. Purge your proxy or CDN separately when removing previously public information.

Keep requests focused

Select fewer fields, use sensible page sizes, and avoid expensive formatting on large content bodies. Benchmark your real dataset and host; there is no verified universal latency or throughput guarantee. Protected routes still authenticate before cached data is served and send private, no-store headers.

Filtering, sorting and pagination

Permissions and safe configuration

Installation, endpoint and response troubleshooting