Skip to content
Ishvana Ishvana Docs

Proofread Document

POST
/api/creative/edit/proofread/{document_id}

Run proofreading analysis on a single document, returning consistency queries.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
document_id
required
Document Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

ProofreadResult

Result of a proofreading scan.

object
queries
required
Queries
Array<object>
ProofreadQuery

A query for the author to resolve a consistency issue.

object
id
required
Id
string
documentId
Documentid
string
""
queryType
required
string
Allowed values: spelling contraction hyphenation punctuation formatting naming dialogue numbers
question
required
Question
string
options
required
Options
Array<string>
occurrences
required
Occurrences
Array<object>
ProofreadOccurrence

A single occurrence of a pattern variant in the text.

object
text
required
Text
string
paragraph
required
Paragraph
integer
offset
required
Offset
integer
autoFixable
Autofixable
boolean
default: true
totalPatternsScanned
required
Totalpatternsscanned
integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object