Skip to main content
POST
/
api
/
projects
/
{project}
/
evaluate
/
{key}
Evaluate decision
curl --request POST \
  --url https://api.example.com/api/projects/{project}/evaluate/{key} \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Token: <api-key>' \
  --data '
{
  "context": {
    "customer": {
      "tier": "gold",
      "totalOrders": 50
    },
    "order": {
      "amount": 150
    }
  },
  "trace": false
}
'
{
  "result": {},
  "trace": {},
  "details": {
    "releaseId": "<string>",
    "versionId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Access-Token
string
header
required

Evaluation token from project settings

Path Parameters

​
project
string
required

Project slug or ID

​
key
string
required

Decision model key (path)

Body

application/json

Evaluation request with context data

Request body for decision evaluation

​
context
object
required

Input data for the decision model. The structure depends on your decision model's expected input.

​
trace
boolean | null
default:false

When true, includes detailed trace information in the response for debugging purposes.

Response

Evaluation result

Response from decision evaluation

​
result
object

The output from the decision model evaluation

​
trace
object

Detailed trace information (only included when trace=true in request)

​
details
object

Metadata about the evaluation