OpenAPI Spec

The OpenAPI specification is a standardized, machine-readable description of the Unmarkdown™ REST API. It documents every endpoint, request parameter, response schema, and authentication requirement in a structured JSON format. Tools and libraries can consume this spec to generate client code, build documentation, and validate API requests automatically.

The spec is available at a public URL. No authentication is required.

# Fetch the OpenAPI spec
curl https://unmarkdown.com/openapi.json

// JavaScript
const response = await fetch("https://unmarkdown.com/openapi.json");
const spec = await response.json();
console.log(spec.info.title); // "Unmarkdown API"

# Python
import requests

spec = requests.get("https://unmarkdown.com/openapi.json").json()
print(spec["info"]["title"])  # "Unmarkdown API"

The spec covers all 11 endpoints in the Unmarkdown™ REST API:

• POST /v1/convert: Convert markdown to styled HTML
• POST /v1/documents: Create a new document
• GET /v1/documents: List your documents
• GET /v1/documents/:id: Get a single document
• PATCH /v1/documents/:id: Update a document
• DELETE /v1/documents/:id: Delete a document
• POST /v1/documents/:id/publish: Publish a document
• DELETE /v1/documents/:id/publish: Unpublish a document
• POST /v1/documents/publish: Create and publish in one call
• GET /v1/templates: List available templates
• GET /v1/usage: Check your API quota

The OpenAPI spec works with a wide range of API tools and development workflows:

• Postman: Import the spec URL to create a complete collection with all endpoints pre-configured
• Insomnia: Import the JSON file to set up your workspace automatically
• Swagger UI: Point to the spec URL for interactive, browser-based API exploration
• Code generators: Use openapi-generator to create typed client libraries in Python, TypeScript, Go, Ruby, and other languages
• Validation: Use the spec to validate your API requests and responses during development

The Unmarkdown™ API spec follows the OpenAPI 3.1 standard. OpenAPI 3.1 is fully compatible with JSON Schema, which means the request and response schemas can be used directly for validation in most programming languages. The spec is updated alongside the API, so it is always current.