/api (for example
https://app.oxygen-hq.com/api). For automation — CI gates, scheduled
syncs, embedded integrations — use the curated, API-key-only surface at
/external/api/{workspace_id}. Interactive, always-current endpoint
docs live at /apidoc (Swagger UI).
For the full, always-current list of endpoints — with request/response schemas
and a try-it console — browse the Swagger UI at /apidoc on your Oxygen
instance (for example https://app.oxygen-hq.com/apidoc).
Calling the API from a terminal
Theoxyc CLI (npm install -g @oxy-hq/cli, Node 20+) is a gh api-style
client for the same API. It signs you in, discovers routes from the running
server, and shows each endpoint’s request and response shape:
oxyc targets https://app.oxygen-hq.com by default; pass --target <url>
for another deployment. For the /external/api surface it reads an API key
from OXY_API_KEY (or the variable named by --api-key-env). Run
oxyc --help for every command.