---
title: "OpenAPI description"
method: GET
path: "/api/v1/openapi.json"
tags: ["openapi"]
---

# OpenAPI description

`GET /api/v1/openapi.json`

## Request

- Base URL: `https://dev.to`
- URL: `https://dev.to/api/v1/openapi.json`
- Auth: none required

Retrieve the machine-readable OpenAPI contract for this Forem instance.

Automated clients should use this document instead of inferring endpoint schemas from responses or errors.

## Response `200`

The OpenAPI description

- object
  - `openapi` string, required
  - `info` object, required
  - `paths` object, required

## Changes

- **2026-08-31** (v1) `fa06b5d2c9d1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/forem/apis/forem-api-v1/changes/api/v1/openapi.json/get.md)

---

[API](https://skmtc.dev/forem/apis/forem-api-v1.md) - [All operations](https://skmtc.dev/forem/apis/forem-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/forem/apis/forem-api-v1/revisions/36f1cf80cf48?raw)