---
title: "Api Schema"
method: GET
path: "/api/v1/schema"
---

# Api Schema

`GET /api/v1/schema`

## 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/v1/schema`
- Auth: none declared

Machine-readable endpoint catalog.

## Response `200`

Successful Response

- ApiSchemaResponse: Returned by GET /api/schema and GET /api/v1/schema.
  - `version` string, required: API version label, e.g. 'v1'.
  - `endpoints` ApiSchemaEndpoint[], required: Ordered catalog of public routes.
    - `path` string, required: URL path, e.g. '/api/data'.
    - `method` string, required: HTTP verb (GET / POST / …).
    - `params` string[], nullable: Query-param names accepted by the route. Absent on no-arg routes.
  - `count` integer, required: Length of `endpoints` (server-side computed).
  - `note` string, nullable: Free-form informational note. Currently used to flag the partial FastAPI migration coverage; safe for clients to ignore.

---

[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)