KrexelDocsHome

API contract status

Use the stable contract while the full reference is regenerated.

The previous hand-written endpoint catalogue drifted from the Worker and has been withdrawn from search. This page contains only the public contract verified against the current source.

Origin and authentication

API origin
https://api.krexel.com
API prefix
/api/v1
Customer key
krx_...
Header
Authorization: Bearer <key>
Client variable
KREXEL_API_KEY

Plaintext customer keys are shown only when created. Keep them in a client secret field or environment variable; never put one in a URL, repository, browser bundle, or support screenshot.

Hosted MCP

POST https://api.krexel.com/api/v1/mcp
Authorization: Bearer krx_...
Content-Type: application/json

The hosted Worker registers fifteen tools. The local npm MCP is a separate nine-tool stdio implementation.

  • list_sites
  • get_site
  • list_deploys
  • get_deploy
  • create_site
  • trigger_deploy
  • get_deploy_logs
  • list_domains
  • attach_domain
  • ship_site
  • list_files
  • read_file
  • edit_file
  • rollback
  • get_status

attach_domain remains visible for protocol compatibility but must return an unavailable result until operators explicitly enable verified custom-hostname infrastructure.

Current boundaries

  • Custom-hostname attach and registrar instructions are paused.
  • Remote MCP clients connect at https://krexel.com/api/mcp with automatic OAuth; API keys remain for local and direct API clients.
  • The full REST route catalogue will return only after it is generated or statically checked against Worker routing source.

Route presence in source is not, by itself, a support or availability guarantee.