API Reference Platform

Platform Endpoints

3 utility endpoints: check what features the server supports, sign up for the Pro waitlist, and verify the server is running.

JWT Token

API Key

JWT set Key set No credentials set

Platform

Return machine-readable server capabilities for adaptive CLI behavior.

Response

Field	Type	Required	Description
app_name	`string`	Yes	Application display name*
api_version	`string`	Yes	Current API version*
features	`object`	Yes	Feature flags and client-safe capabilities*
cli	`object`	Yes	Recommended CLI version and structured output formats*

Response 200 OK

{
  "app_name": "RESTume",
  "api_version": "1.0.0",
  "features": {
    "structured_cli_output": true,
    "owner_bearer_auth": true
  },
  "cli": {
    "recommended_min_version": "0.2.0",
    "structured_output_formats": ["json", "yaml", "tsv"]
  }
}

Capture interest in the Pro plan waitlist.

Request Body

Field	Type	Required	Description
email	`string`	Yes	Signup email*
source	`string`	No	pricing, dashboard, or banner
challenge_token	`string`	No	Optional anti-bot clearance token

Response

Field	Type	Required	Description
message	`string`	Yes	Stable success response*

email *

source

challenge_token

Request

{
  "email": "you@example.com",
  "source": "pricing"
}

Response 200 OK

{
  "message": "Thanks. We'll email you when Pro launches."
}

Operational health probe for uptime checks.

Response

Field	Type	Required	Description
status	`string`	Yes	Health status string*
app	`string`	Yes	Application name*
version	`string`	Yes	Current version*

Response 200 OK

{
  "status": "healthy",
  "app": "restume",
  "version": "1.0.0"
}