---
title: "This document"
method: GET
path: "/.well-known/openapi.json"
---

# This document

`GET /.well-known/openapi.json`

## Request

- Base URL: `https://charm.ing`
- URL: `https://charm.ing/.well-known/openapi.json`
- Auth: none declared

Serves the canonical machine-readable OpenAPI 3.1 spec for the Charming API. The unversioned `/openapi.json` path 308s here.

## Response `200`

OpenAPI 3.1 spec

- object: OpenAPI 3.1 document. Conforms to https://spec.openapis.org/oas/v3.1.0 — the spec is too deep to enumerate inline.

---

[API](https://skmtc.dev/charm/apis/charming-api.md) · [All operations](https://skmtc.dev/charm/apis/charming-api/llms.txt) · [OpenAPI document](https://skmtc.dev/charm/apis/charming-api/revisions/a9d06c419b3a?raw)