Get Readiness

GET

/api/creative/edit/readiness/{document_id}

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Calculate publishing readiness score for a document.

Parameters

Path Parameters

document_id

required

Document Id

string

Responses

200

Successful Response

ReadinessBreakdown

Transparent, weighted composite publishing readiness score.

object

documentId

Any of:

string

string

null

null

documentTitle

Any of:

string

string

null

null

proseguardScore

required

Proseguardscore

ProseGuard score

number

<= 100

proseguardErrors

required

Proseguarderrors

integer

proseguardWarnings

required

Proseguardwarnings

integer

lorekeeperScore

required

Lorekeeperscore

Lorekeeper consistency score

number

<= 100

lorekeeperIssues

required

Lorekeeperissues

integer

mlHealthScore

required

Mlhealthscore

ML health overall score

number

<= 100

editCompletionScore

required

Editcompletionscore

Pct of suggestions addressed

number

<= 100

pendingSuggestions

required

Pendingsuggestions

integer

overallScore

required

Overallscore

Weighted composite score

number

<= 100

isReady

required

Isready

Whether score meets threshold

boolean

threshold

required

Threshold

Publishing readiness threshold

number

<= 100

weightProseguard

required

Weightproseguard

Effective ProseGuard weight used

number

<= 1

weightLorekeeper

required

Weightlorekeeper

Effective Lorekeeper weight used

number

<= 1

weightMlHealth

required

Weightmlhealth

Effective ML health weight used

number

<= 1

weightEditCompletion

required

Weighteditcompletion

Effective edit completion weight used

number

<= 1

lorekeeperChecked

Lorekeeperchecked

Whether Lorekeeper has been run

boolean

default: true

mlHealthChecked

Mlhealthchecked

Whether ML health snapshot exists

boolean

default: true

editCompletionChecked

Editcompletionchecked

Whether an edit session exists

boolean

default: true

proseguardRecommendation

required

Proseguardrecommendation

ProseGuard advice

string

lorekeeperRecommendation

required

Lorekeeperrecommendation

Lorekeeper advice

string

mlHealthRecommendation

required

Mlhealthrecommendation

ML health advice

string

editCompletionRecommendation

required

Editcompletionrecommendation

Edit completion advice

string

overallRecommendation

required

Overallrecommendation

Overall readiness advice

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