Skip to main content
POST
/
v1
/
evaluate
Evaluate a ruleset against a geometry
curl --request POST \
  --url https://api.example.com/v1/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "crs": "<string>",
    "geometry": {
      "coordinates": [
        [
          [
            123
          ]
        ]
      ],
      "type": "Polygon",
      "bbox": [
        123
      ]
    },
    "scheme": {
      "type": "br:cnpj",
      "value": "12.345.678/0001-90"
    }
  },
  "ruleset_id": "<string>",
  "ruleset": {},
  "ruleset_as_of": "2023-11-07T05:31:56Z"
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
accept
string | null
​
Idempotency-Key
string | null

Query Parameters

​
explain
boolean
default:false

When true, returns cardinality estimates per set without evaluating user terminals.

​
lint
boolean
default:false

When true, includes ruleset-linter findings in meta.lint alongside the verdict.

Body

application/json
​
input
EvaluationInput · object
required

User-supplied data for the request — geometry, identifier bag, and an optional source CRS. At least one of input.geometry or input.subjects MUST be present (enforced inside the input model).

​
ruleset_id
string | null
required

Catalog ruleset reference. Accepts name@version for a pinned version or just name for the latest. Mutually exclusive with ruleset.

Maximum string length: 256
​
ruleset
Ruleset · object | null

Inline ruleset document (same shape as the DSL). Mutually exclusive with ruleset_id.

​
ruleset_as_of
string<date-time> | null

Point-in-time read for the ruleset. Only takes effect when ruleset_id is passed without @version — resolves to the highest version whose created_at <= ruleset_as_of. Ignored when ruleset_id pins a version explicitly or when ruleset (inline) is used.

Response

Evaluation result.

The response is of type FeatureCollection · object.