Skip to content

Prepare an import

POST/v2/themes/{themeId}/rive-graphics/imports/{jobId}/prepare

POST
/v2/themes/{themeId}/rive-graphics/imports/{jobId}/prepare
curl --request POST \
--url https://api.ligr.live/rest/v2/themes/1/rive-graphics/imports/example/prepare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "versionId": "example", "repair": true }'

Beta. This operation can change between minor versions. See Beta status.

Seal the uploaded object version and start native Rive preparation.

themeId
required
number format: double
jobId
required
string
Media typeapplication/json
object
versionId
required

Exact opaque object version returned by the upload response headers.

string
repair

Apply the proven repair for stale references to deleted items in an editable source. The uploaded file stays unchanged. Ignored for runtime files.

boolean
Examplegenerated
{
"versionId": "example",
"repair": true
}

Accepted

Media typeapplication/json
object
traceparent
string
nullable
jobId
required
string
candidateId
required
string
themeId
required
integer format: int32
status
required
string
Allowed values: uploading queued processing completed selection-required ready failed abandoned cancelled
expiresAt
required
string
error
required
object
code
required
string
message

What is wrong with the file and what to do, when the import knows more than the code.

string
nullable
problems
Array<object>
nullable
object
severity
required
string
kind
required
string
line
required
integer format: int32
message
required
string
location

Where the problem is in the Rive editor, for example Clock › State Machine 1 › Layer 1 › Any State → HT.

string
nullable
repair

The repair offer for stale references to deleted items, when the source is an editable .rev.

object
total
required
integer format: int32
items
required
Array<object>
object
rule
required

reference-cleared, leftover-removed or editor-field-cleared.

string
element
required

The Rive object type, or * for a group of mixed types.

string
attribute
required
string
location
required

Where the repair is in the Rive editor. Null for leftovers outside any artboard.

string
nullable
count
required
integer format: int32
details
required

Up to 20 specific places inside the location, for example a transition.

Array<string>
available
required

True only when every compile problem has a proven repair. Then POST imports/{jobId}/repair applies it.

boolean
candidates
required
Array<object>
nullable
object
kind
required
string
Allowed values: runtime editor project
entry
required
string
metadata
required
object
artboards
required
Array<object>
object
index
required
integer format: int32
name
required
string
width
required
number format: double
height
required
number format: double
defaultViewModelIndex
required
integer format: int32
nullable
stateMachines
required
Array<object>
object
index
required
integer format: int32
name
required
string
inputs
required
Array<object>
object
index
required
integer format: int32
name
required
string
type
required
string
Allowed values: boolean number trigger unknown
initialValue
required
Any of:
boolean
viewModels
required
Array<object>
object
index
required
integer format: int32
name
required
string
instanceNames
required
Array<string>
defaultInstanceBindings
required
Array<object>
nullable
object
path
required
string
pathSegments
Array<string>
name
required
string
type
required
string
enumValues
Array<string>
imageDimensions
object
width
required
number format: double
height
required
number format: double
enumName
string
list
object
length
required
integer format: int32
modelIndex
required
integer format: int32
nullable
resolution
required
string
Allowed values: resolved empty ambiguous unavailable
unresolved
boolean
properties
required
Array<object>
object
name
required
string
type
required
string
enumName
string
instances
required
Array<object>
object
index
required
integer format: int32
nullable
name
required
string
nullable
bindings
required
Array<object>
object
path
required
string
pathSegments
Array<string>
name
required
string
type
required
string
enumValues
Array<string>
imageDimensions
object
width
required
number format: double
height
required
number format: double
enumName
string
list
object
length
required
integer format: int32
modelIndex
required
integer format: int32
nullable
resolution
required
string
Allowed values: resolved empty ambiguous unavailable
unresolved
boolean
assets
required
Array<object>
object
index
required
integer format: int32
id
required
integer format: int32
name
required
string
type
required
string
Allowed values: image font audio unknown
uniqueFilename
required
string
embedded
required
boolean
embeddedSize
required
integer format: int32
embeddedSha256
required
string
nullable
cdnId
required
string
nullable
unresolved
required
boolean
bundledImage
object
entry
required
string
size
required
integer format: int32
width
required
integer format: int32
height
required
integer format: int32
decoded
required
boolean
runtime
required
object
sha256
required
string
size
required
integer format: int32
preview
required
object
url
required
string
expiresAt
required
string
assets
Array<object>
object
uniqueFilename
required
string
url
required
string
sha256
required
string
graphicId
required
string
nullable
assetId
required
string
nullable
repair
required

True when the import was asked to apply the proven repair.

boolean
repairs
required

What the repair changed, once the import is ready. The uploaded file stays unchanged.

object
total
required
integer format: int32
items
required
Array<object>
object
rule
required

reference-cleared, leftover-removed or editor-field-cleared.

string
element
required

The Rive object type, or * for a group of mixed types.

string
attribute
required
string
location
required

Where the repair is in the Rive editor. Null for leftovers outside any artboard.

string
nullable
count
required
integer format: int32
details
required

Up to 20 specific places inside the location, for example a transition.

Array<string>
Example
{
"status": "uploading",
"candidates": [
{
"kind": "runtime"
}
],
"metadata": {
"artboards": [
{
"stateMachines": [
{
"inputs": [
{
"type": "boolean"
}
]
}
]
}
],
"viewModels": [
{
"defaultInstanceBindings": [
{
"list": {
"resolution": "resolved"
}
}
],
"instances": [
{
"bindings": [
{
"list": {
"resolution": "resolved"
}
}
]
}
]
}
],
"assets": [
{
"type": "image"
}
]
}
}

Invalid Rive request

Media typeapplication/json
object
message
required
string
code
required
string
Examplegenerated
{
"message": "example",
"code": "example"
}

Theme, import, graphic, version, or file not found

Media typeapplication/json
object
message
required
string
code
required
string
Examplegenerated
{
"message": "example",
"code": "example"
}

Rive import or graphic state conflict

Media typeapplication/json
object
message
required
string
code
required
string
Examplegenerated
{
"message": "example",
"code": "example"
}

Rive candidate or source is no longer available

Media typeapplication/json
object
message
required
string
code
required
string
Examplegenerated
{
"message": "example",
"code": "example"
}

Rive file or configuration cannot be used

Media typeapplication/json
object
message
required
string
code
required
string
Examplegenerated
{
"message": "example",
"code": "example"
}

Rive source imports are unavailable

Media typeapplication/json
object
message
required
string
code
required
string
Examplegenerated
{
"message": "example",
"code": "example"
}