Skip to content

Scan Document All Languages

POST
/api/creative/conlang/scan-document

Scan text for conlang words across all project languages.

ConlangScanRequest

Request body for scanning text across all project languages.

object
text
required
Text
string

Successful Response

ConlangScanResponse

Response with conlang word matches.

object
matches
required
Matches
Array<object>
ConlangMatchResult

A single conlang word match in document text.

object
word
required
Word
string
translation
required
Translation
string
partOfSpeech
required
Partofspeech
string
languageName
required
Languagename
string
startPos
required
Startpos
integer
endPos
required
Endpos
integer
total
required
Total
integer

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