Skip to content
Developers

Select an archive entry

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

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

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

Select one supported source from an inspected archive.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
themeId
required
number format: double
jobId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
entry
required

Exact candidate entry returned by the selection-required status.

string
Examplegenerated
{
  "entry": "example"
}

Responses

Section titled “Responses”

202

Section titled “202”

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
problems
Array<object>
nullable
object
severity
required
string
kind
required
string
line
required
integer format: int32
message
required
string
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
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"
      }
    ]
  }
}

400

Section titled “400”

Invalid Rive request

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

404

Section titled “404”

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

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

409

Section titled “409”

Rive import or graphic state conflict

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

410

Section titled “410”

Rive candidate or source is no longer available

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

422

Section titled “422”

Rive file or configuration cannot be used

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

503

Section titled “503”

Rive source imports are unavailable

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