YOyomu

Explain Revise Change

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.

post/explain_revise_change

Request

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

Request body

textstring required
original_spanstring required
new_spanstring required
planstring nullable
words_usedinteger nullable
prefer_gptstring nullable
rule_namestring required
promptstring required
strength'light' | 'medium' | 'strong' nullable
positive_examplesstring[] nullable
negative_examplesstring[] nullable
descriptionstring nullable
languagestring nullable
streamboolean nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.