API Reference · RKX API Studio 1.0.0
Route and response contract
GET /wp-json/rkx-api-studio/v1/{slug} returns an array of mapped records. Pro namespaces replace rkx-api-studio/v1. X-WP-Total and X-WP-TotalPages provide pagination totals. Cache-enabled responses add X-RKX-API-Studio-Cache. Protected responses use private, no-store Cache-Control.
Builder configuration
Set name, immutable URL slug, method, data source, fields, ordered field formatters, per-page, offset, order, orderby, parameter mode, taxonomy filters and protection. Pro adds namespace and allowed keys. Configure with the builder; importing arbitrary JSON does not bypass validation or authorization.
Request parameters
page starts at 1. per_page is bounded to 1–100. order is ASC or DESC. orderby depends on source. Custom mode uses stored settings for per_page, offset, order, orderby and taxonomy filters. Default parameter mode supports recognized source-specific WordPress parameters and configured taxonomy slugs with term IDs.
Error handling
Inspect both HTTP status and the JSON body. Invalid parameters can produce WordPress REST validation errors; invalid_data_source identifies an unavailable source. Protected requests can return 401. Pro write payloads over 1 MB return 413, invalid JSON returns 400, and handler failures return a safe server error. Do not depend on one universal error message for every failure.
Related guides
Filtering, sorting and pagination