Skip to content

Resolve scoped override targets

POST
/api/writing/proseguard/rules/{project_id}/targets/resolve

Resolve document, scene, and character scope IDs into human-readable labels for analysis surfaces.

project_id
required
Project Id
string
ScopeTargetResolveRequest

Batch request for resolving scoped override targets.

object
refs
required
Refs
Array<object>
ScopeTargetReference

Reference to a scoped override target.

object
scope
required
Scope
string
Allowed values: document scene character
scopeId
Any of:
string

Successful Response

ScopeTargetResolveResponse

Response containing resolved scoped override target labels.

object
targets
required
Targets
Array<object>
ScopeTargetResolutionResponse

Resolved label metadata for a scoped override target.

object
scope
required
Scope
string
Allowed values: document scene character
scopeId
Any of:
string
label
required
Label
string
entryType
Any of:
string
message
required
Message
string

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