RKX API Studio Docs
RKX API Studio Docs

Creating Endpoints

Free Features · RKX API Studio 1.0.0

Before you begin

Activate Free and publish an unpassworded test post. Use an administrator account. A public endpoint must contain only fields you intend to share.

Create and save the endpoint

Build a small GET endpoint first; add protection before sharing any non-public integration URL.

  1. Open RKX API Studio → All Endpoints and select Create Endpoint.
  2. Keep GET selected. Enter Articles API as the name and articles as the slug.
  3. Select Posts as the Data Source. The slug will be locked after the first save.
  4. Add ID, Title, Excerpt and Featured Image URL to the Active Output Zone.
  5. Keep Per Page at 10 and review the JSON sample below the builder.
  6. Select Save Endpoint. Copy the saved API URL from All Endpoints.
Actual WordPress admin, captured with Pro active. Selecting Posts is a shared Free capability; the custom namespace control shown belongs to Pro.
  1. The endpoint name is an admin label; the slug becomes the route.
  2. Posts is the selected source. Custom namespaces visible in this Pro-active capture require Pro.

Screenshot detail

Endpoint settings with Articles API, the articles slug and Posts selected as the data source

Actual WordPress admin, captured with Pro active. Selecting Posts is a shared Free capability; the custom namespace control shown belongs to Pro.

Test the saved route

Request the exact saved URL. The body is an array of mapped records. If it returns an empty array, check published content, source, page and filters.

Bash
curl -i 'https://example.com/wp-json/rkx-api-studio/v1/articles?page=1'

Posts, pages, custom types and taxonomies

Select fields and configure JSON output

Preview and manage endpoints