Codex Desktop APIGet the API

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 local Codex OAuth profiles on the customer's own machine.

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

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. Add or select the Codex OAuth profile that should execute requests.
  5. Install the bundled codexos-api skill and run the probe.
  6. Use the desktop Updates page to check or install newer signed releases.

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 profiles = await fetch(`${baseUrl}/v1/auth/profiles`).then((res) => res.json());
const authProfileId = profiles.defaultProfileId;

const response = await fetch(`${baseUrl}/v1/responses`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    provider: { kind: "codex" },
    profile: "pure",
    authProfileId,
    model: "gpt-5.5",
    input: [{
      role: "user",
      content: [{ type: "text", text: "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.