Skip to content
Developers

Evaluate graphic bindings

POST/v2/themes/{themeId}/rive-graphics/{graphicId}/evaluate

POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/evaluate
curl --request POST \
  --url https://api.ligr.live/rest/v2/themes/1/rive-graphics/example/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scenario": "example", "variables": { "additionalProperty": true }, "step": 1 }'

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

Checks every data binding and every user expression of the working draft. The response mode says whether the server produced values or checked syntax and references only. unresolved counts the binding and user expression rows that failed.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
scenario

Demonstration scenario name. Omit to evaluate against an empty context.

string
variables

Control variable values by name. They override the stored defaults.

object
key
additional properties
Any of:
boolean
step

Zero-based step of the scenario data sequence. Defaults to the last step.

number format: double
Examplegenerated
{
  "scenario": "example",
  "variables": {
    "additionalProperty": true
  },
  "step": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
mode
required

full reports values. static checks syntax and references only.

string
Allowed values: full static
scenario
required
string
nullable
bindings
required
Array<object>
object
id
required
string
expression
required
string
value
Any of:
boolean
error
required

An error code, or null when the binding resolves.

string
nullable
userExpressions
required

One row per user expression. id is the user expression id.

Array<object>
object
id
required
string
expression
required
string
value
Any of:
boolean
error
required

An error code, or null when the binding resolves.

string
nullable
unresolved
required

Count of rows in bindings and userExpressions whose error is not null.

number format: double
Example
{
  "mode": "full"
}