Get Document Profile

GET

/api/writing/worldspell/document-profile/{document_id}

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Get a document’s voice profile.

Parameters

Path Parameters

document_id

required

Document Id

string

Responses

200

Successful Response

DocumentVoiceProfileResponse

Response for a document’s voice profile.

object

documentId

required

Documentid

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

default: informal

Allowed values: formal informal aave dialectal archaic colloquial custom

customRegisterLabel

Any of:

string

string

null

null

examplePassages

Examplepassages

Reference text showing how this voice sounds

Array<string>

notes

Notes

Author notes about this voice

string

""

createdAt

required

Createdat

string

updatedAt

required

Updatedat

string

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