docs(write): add /v2/write/correct corrections-only endpoint#344
Open
healqq wants to merge 7 commits into
Open
docs(write): add /v2/write/correct corrections-only endpoint#344healqq wants to merge 7 commits into
healqq wants to merge 7 commits into
Conversation
Documents the new corrections-only mode on the Write API: - New `/v2/write/correct` path and `CorrectText` tag in the OpenAPI spec. - New `api-reference/improve-text/correct-text.mdx` page driven by the spec. - Updated `improve-text.mdx` overview to describe both endpoints and link to the new one. - Updated the FAQ entry that previously said Corrections Only mode was UI-only — it is now also available via `/write/correct`. - Registered the new page in `docs.json` navigation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The /v2/write/rephrase endpoint returns target_language in each improvements item, and the narrative MDX (improve-text.mdx) already documents it as a required ResponseField. The OpenAPI spec's response schema was missing it. Bring the spec in line with both the actual API behavior and the narrative docs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The rephrase and correct endpoint pages previously had only an `openapi:` frontmatter directive, so the rendered pages opened straight into the auto-generated request schema with no orientation. Add: - A short paragraph at the top of each page explaining what the endpoint does, when to choose it over the sibling endpoint, and a link to the overview for shared details (supported languages, size limits). - Frontmatter `title` and `description` so the page titles read naturally in the nav and in search results. - Rename the rephrase endpoint's OpenAPI summary from "Request text improvement" to "Improve text" to match the new page title and read more naturally. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Drop the imperative second-person framing ("Send ... to", "use X
instead", "See the overview for...") on the rephrase and correct
endpoint pages. The intros and frontmatter descriptions now describe
what each endpoint does rather than instructing the reader.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
shirgoldbird
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new corrections-only mode on the Write API.
/v2/write/correctpath and aCorrectTexttag toapi-reference/openapi.yaml.api-reference/improve-text/correct-text.mdx, driven by the OpenAPI spec.Improve textoverview (api-reference/improve-text.mdx):/write/rephraseand/write/correctand links to each.docs.json.Behavior summary
/v2/write/correctperforms a minimal-change correction pass on one or more texts. Unlike/v2/write/rephrase, it does not acceptwriting_styleortoneand does not rewrite for style.Request body (JSON or form-urlencoded):
textarray[string]target_langstringTargetLanguageWriteset as/write/rephrase)Response: same
improvementsarray shape as/write/rephrase, withtext,target_language, anddetected_source_language.Validation (local PublicApi → dev upstreams)
EN-US"This are wrong sentence..."→"These are wrong sentences..."DE) target"Ich gehen heute zum Schule."→"Ich gehe heute zur Schule."textarrayMissing parameter text.Content-Type(text/plain)target_langValue for target_lang not supported.Test plan
mint devrenders the newImprove text > Corrections Onlypage without errorsmint broken-linksandmint broken-links --check-anchorspassimprovementsarray