Health

API version discovery

Changed on

Discovery endpoint that points clients (CLI, agents, browsers) at the OpenAPI spec and the Scalar docs UI. Public.

get/api/v1

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1
  • Auth: none declared

Response

API banner.

version'v1' required
openapistring required
docsstring required
status'live' required

Example response

{
  "openapi": "/api/openapi",
  "docs": "/api/docs"
}

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status