Oxford Response

Oxford Response

Connect an Oxford Response server, store a server key, and use /oxford.

Oxy Controller integrates with the Oxford Response API so Discord staff can inspect a connected private server. Oxford Response is a Roblox roleplay experience; the API is operated by Oxford Response, not by Oxy. Exact fields returned by /oxford depend on the current Oxford API implementation.

  • /oxfordView connected Oxford Response data.
  • /settingsAdd or replace the server key.
  • /robloxLink Roblox accounts used by related workflows.

Server keys

A server key is a secret owned by the Oxford Response server owner. It is retrieved from Oxford’s Server Management → External → API Key, and typically requires the Oxford API package. Treat it like a password: it can read live player data and, on the Oxford API, may allow administrative commands.

  • Never commit a server key to git, a screenshot, or this website.
  • Never paste a real key into Discord chat, tickets, or examples.
  • Use a placeholder such as oxfd_sk_example in documentation only.
  • Rotate the key in Oxford if it may have leaked, then update /settings.

Connecting an Oxford Response server

  1. 01

    Confirm API access on the Oxford server

    The Oxford server owner must own the API package and be able to open Server Management → External → API Key. If that page is unavailable, Oxy cannot connect.

  2. 02

    Copy the server key privately

    Copy the key once. Do not share it with members who should not have full API access. Oxy only needs it stored in server settings.

  3. 03

    Add the server key in Oxy

    Run /settings and open Oxford Response. Paste the key into the field your version provides. Oxy should store it server-side — not echo it back in public channels.

  4. 04

    Run /oxford

    In a staff channel, run /oxford. You should see server information if the key is valid and the Oxford API is reachable. If not, use the troubleshooting section.

Using /oxford

The /oxford command is the Discord surface for connected data. Subcommand labels, if present, depend on the installed version. In general you can expect views for:

  • Server information — name, status, and other summary fields the API returns.
  • Players — who is online, with team, location, or callsign when the API provides them.
  • Locations — position or location-related operational data when exposed.
  • Operational data — other live fields the current Oxford API makes available (queue, vehicles, and similar). Oxy only shows what the API returns.

What the Oxford API can provide

The public Oxford API documents routes under https://api.oxfd.re/v1 such as server summary, players, queue, bans, vehicles, and various logs. Oxy may surface a subset of those through /oxford. This site does not claim that every Oxford route has a matching slash command.

Checking API health

When the Discord command fails, check whether the Oxford API itself is up. A simple unauthenticated probe against the documented health path:

cURL
curl -sS https://api.oxfd.re/v1/health

A reachable health endpoint does not prove your server key is valid. It only tells you the API service is responding. Key errors typically appear as 403 from authenticated routes.

Troubleshooting API connection problems

SymptomLikely causeWhat to try
/oxford errors immediatelyNo key stored, or Oxy cannot read settingsRe-open /settings → Oxford Response and confirm a key is saved.
Forbidden / invalid keyWrong key, rotated key, or missing API packageHave the Oxford owner re-copy the key. Do not debug keys in public chat.
Empty or partial dataThe Oxford server is offline, empty, or the API field is unavailableCheck in-game. Compare with the current Oxford API docs.
TimeoutsOxford API or network path unavailableCheck /v1/health. Retry later. Do not loop requests.