---
title: "Explain Revise Change"
method: POST
path: "/explain_revise_change"
---

# Explain Revise Change

`POST /explain_revise_change`

## Request

- Base URL: `https://api.yomu.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.yomu.ai/explain_revise_change`
- Auth: API key in header `ACCESS_TOKEN`

Explain why a specific change was made during text revision.
This endpoint analyzes the before/after spans and explains the reasoning
behind the revision based on the applied rule.

## Request body

- ExplainReviseChangeRequest
  - `text` string, required
  - `original_span` string, required
  - `new_span` string, required
  - `plan` string, nullable
  - `words_used` integer, nullable
  - `prefer_gpt` string, nullable
  - `rule_name` string, required
  - `prompt` string, required
  - `strength` 'light' | 'medium' | 'strong', nullable
  - `positive_examples` string[], nullable
  - `negative_examples` string[], nullable
  - `description` string, nullable
  - `language` string, nullable
  - `stream` boolean, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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