Skip to main content
POST
/
expressions
/
robot
/
{robotId}
/
eval
Evaluates an expression
curl --request POST \
  --url https://api.inorbit.ai/expressions/robot/{robotId}/eval \
  --header 'Content-Type: application/json' \
  --header 'x-auth-inorbit-app-key: <api-key>' \
  --data '
{
  "expression": "<string>",
  "attributes": {}
}
'
{
  "success": true,
  "value": {},
  "message": "<string>"
}

Authorizations

​
x-auth-inorbit-app-key
string
header
required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

​
robotId
string
required

The robot's id

Body

application/json

Evaluates an expression

​
expression
string

Expression to be evaluated. See expressions language reference

​
attributes
object

A dictionary of data robot source values. They will be used as if they were the current values for those data sources at the time of evaluating the expression. Useful for testing scenarios and expressions without having to send actual data from robots.

Response

The result of the evaluation

Result of evaluating an expression

​
success
boolean

Flag that indicates if the expression was evaluated without errors

​
value

Result of the evaluation. The type depends on the result of the evaluated expression.

​
message
string

Information about errors (if any)