Onboarding docs

Install, activate, and call your local Codex API.

These distribution docs cover the buyer journey for a Responses-style API that runs against the customer's local Codex session.

What ships in the Windows release

Codex Desktop API is a licensed local app that starts a Responses-style loopback API, checks local Codex readiness, and includes onboarding for the bundled codexos-api skill.

Local auth boundary

Codex and ChatGPT auth remain on the customer's machine. The distribution service handles payment, license fulfillment, email delivery, and gated download metadata only.

API quickstart

After activation, call the local base URL reported by the desktop app. Start with health and readiness checks, list models, then send unary or streaming response requests.

License and billing recovery

The manage page is tokenized. It can show fulfillment state, download metadata, resend the delivery email, and open the Stripe billing portal after provider configuration is complete.

Quickstart shape

The first run should be explicit and verifiable.

  1. Download the Windows artifact from success or manage.
  2. Activate with the Keygen license sent after checkout.
  3. Confirm local Codex readiness without exposing auth material.
  4. Install the bundled codexos-api skill and run the probe.

API sample

Start with a readiness check.

const baseUrl = "http://127.0.0.1:48741";

const ready = await fetch(`${baseUrl}/ready`).then((res) => res.json());
if (!ready.ready) throw new Error("Codex Desktop API is not ready yet");

const response = await fetch(`${baseUrl}/v1/responses`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    provider: { kind: "codex", profile: "pure" },
    model: "gpt-5.5",
    input: "Summarize the current app state."
  })
});

Support

For launch recovery, use the manage link from your fulfillment email or contact support@novelty.media. Do not send Codex tokens, cookies, browser storage, or license keys in support messages unless a secure support channel is provided.