apidoc

apidoc is a command for Claude Code from oxy-hq/oxygen. It costs 0 tokens per session (1,091 once invoked), scanned A, original, Apache-2.0.

Documentation for the Oxy HTTP API, a set of web endpoints for querying databases, managing threads, starting workflows, and configuring workspaces.

In plain words
What is it for?
It helps developers use API keys or login tokens, install the command-line client, and send requests to the documented endpoints.
Why use it?
It explains how to authenticate and call the API, reducing guesswork when integrating another program with Oxy.

Command for Claude Code

Written for Claude Code: a Claude Code command (commands/*.md).

Good fit It helps developers use API keys or login tokens, install the command-line client, and send requests to the documented endpoints.

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/oxy-hq/oxygen/apidoc
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/oxy-hq/oxygen

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for apidoc

README.md
[![agentmods](https://agentmods.dev/badge/commands/oxy-hq/oxygen/apidoc/github.svg)](https://agentmods.dev/commands/oxy-hq/oxygen/apidoc)
Your own site
<a href="https://agentmods.dev/commands/oxy-hq/oxygen/apidoc"><img src="https://agentmods.dev/badge/commands/oxy-hq/oxygen/apidoc/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for apidoc

Your own site · 80×15
<a href="https://agentmods.dev/commands/oxy-hq/oxygen/apidoc"><img src="https://agentmods.dev/badge/commands/oxy-hq/oxygen/apidoc.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,091 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00000 $0.01091
Opus 5.5 $0.00000 $0.00436
Sonnet 5.5 $0.00000 $0.00218
Haiku 4.5 $0.00000 $0.00109

Measured 2d ago against content hash 00d78b1372ac, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

apidoc scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

# Print the bearer token (useful for raw curl calls)
crates/app/src/cli/commands/apidoc.md · 118 lines

How it starts

The opening of the file, as written. The whole thing — 118 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Overview

The Oxy HTTP API lets you query databases, manage threads, trigger workflows, and configure workspaces programmatically. All endpoints live under /api/ and are documented in the sections below.


Authentication

Two schemes are accepted on every endpoint — supply one:

Scheme How to obtain Header sent
API Key Generate in Settings → API Keys X-API-Key: <key>
Bearer (JWT) Issued by oxyc login or the magic-link flow Authorization: Bearer <token>

Use the Authorize button above to enter either credential; Swagger UI will attach it to every "Try it out" request.


CLI Quick-start

The terminal client is oxyc (@oxy-hq/cli, source in sdk/cli). It replaced the old oxy api, oxy login and oxy logout subcommands, which were removed from the oxy binary.

npm install -g @oxy-hq/cli

oxyc login — authenticate the CLI

oxyc login [--env <env>] [--target <url>] [--login-env <env>...]

Opens your browser to the Oxy web app, captures the session JWT via a loopback callback, and caches it in the credentials file, keyed by host so dev / prod tokens are stored separately: ~/Library/Application Support/oxy/credentials.json on macOS, $XDG_CONFIG_HOME/oxy/credentials.json on Linux (default ~/.config). It is the same file the old oxy login wrote, so an existing login keeps working.

oxyc login                        # authenticate against production
oxyc login --env local            # authenticate against a local oxy serve
oxyc login --env dev --login-env staging   # several deployments, one browser flow each
oxyc login --target https://my.oxy.example.com

After login, every oxyc api call for that target is automatically authenticated — no manual token management needed.

oxyc logout                       # clear the cached token for the default env
oxyc logout --env local

oxyc — call the HTTP API from the terminal

Read the full file on GitHub · 118 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 118 lines · 0 tokens per session scan A 00d78b1372ac

Subscribe to this mod's changes

apidoc is a command published in the GitHub repository oxy-hq/oxygen (203 stars, last pushed yesterday), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 1,091 tokens. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-10-14.