Save Document Profile
PUT /api/writing/worldspell/document-profile/{document_id}
PUT
/api/writing/worldspell/document-profile/{document_id}
Save a document’s voice profile.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” document_id
required
Document Id
string
Request Body required
Section titled “Request Body required ” SaveDocumentProfileRequest
Request to save a document’s voice profile.
object
projectId
required
Projectid
Project ID
string
profile
required
VoiceProfile
Voice profile for a character, faction, species, or document.
Defines intentional language deviations so WorldSpell can suppress grammar/spelling violations that are stylistic choices, not errors.
object
allowedWords
Allowedwords
Words that are intentional (lil, ya, ain’t, finna)
Array<string>
allowedPhrases
Allowedphrases
Multi-word phrases that are intentional
Array<string>
grammarExceptions
Grammarexceptions
LanguageTool rule IDs to suppress (e.g. DOUBLE_NEGATIVES)
Array<string>
voiceRegister
VoiceRegister
Language register
string
examplePassages
Examplepassages
Reference text showing how this voice sounds
Array<string>
notes
Notes
Author notes about this voice
string
Responses
Section titled “ Responses ”Successful Response
SuccessResponse
Generic success response.
object
success
required
Success
boolean
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context