---
title: "Api Keys Trial Status"
method: GET
path: "/api/keys/trial-status"
tags: ["API Keys"]
---

# Api Keys Trial Status

`GET /api/keys/trial-status`

## Request

- Base URL: `https://www.oxfordledge.com` (the document declares no server; this is the origin it was published from)
- URL: `https://www.oxfordledge.com/api/keys/trial-status`
- Auth: none declared

Read-only status for the user's active SDK developer trial.

User-sim Item D follow-on (2026-05-06): the FE settings panel
polls this to render "X of 100 used today / N days left" without
burning a real API call. Returns:

  - 200 {"status": "ok", "active": false} if user has no trial
  - 200 {"status": "ok", "active": true, "key_prefix": "...",
         "days_remaining": N, "count_today": M, "daily_cap": 100,
         "trial_started_at": "..."}

Cheap (one indexed SELECT + one indexed COUNT). Safe to poll.
Does NOT bump the daily counter — pure observability surface.

## Response `200`

Successful Response

- TrialKeyStatusResponse: Response from GET /api/keys/trial-status — read-only trial status panel. Two shapes: when the user has no trial, only `status` and `active` are returned; when they have an active trial, all fields populate. Optional fields handle the no-trial branch.
  - `status` string, required: 'ok' on success
  - `active` boolean, required: True if user has an active (non-revoked) trial key
  - `key_prefix` string, nullable: Stable key prefix; None when no active trial
  - `name` string, nullable: Human-readable key name; None when no active trial
  - `days_remaining` integer, nullable: Whole days until trial expires; None when no active trial
  - `count_today` integer, nullable: Count of trial calls used today (ET-anchored); None when no active trial
  - `daily_cap` integer, nullable: Per-day call quota (100 when active); None when no trial
  - `trial_window_days` integer, nullable: Window length in days (14); None when no active trial
  - `trial_started_at` string, nullable: ISO 8601 timestamp of trial issuance; None when no trial

---

[API](https://skmtc.dev/oxfordledge/apis/oxford-ledge-api.md) · [All operations](https://skmtc.dev/oxfordledge/apis/oxford-ledge-api/llms.txt) · [OpenAPI document](https://skmtc.dev/oxfordledge/apis/oxford-ledge-api/revisions/e832a1260f0b?raw)