JSONPath condition match API

Selects a value from a document via a dot/bracket JSONPath-lite path and tests it with an operator (eq/gt/in/regex/exists/...), returning whether it matched. Answers 'Does the value at this path satisfy this condition?', 'What value is at this path?'.

Price$0.01per request

MethodPOST

Route/v1/workflow/jsonpath-match

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

jsonpathmatchconditionselectorpathextractworkflowpredicate

API URLhttps://x402.hexl.dev/v1/workflow/jsonpath-match

Integration docs

Example request

{
  "document": {
    "user": {
      "roles": [
        "admin"
      ]
    }
  },
  "path": "user.roles[0]",
  "op": "eq",
  "value": "admin"
}

Example response

{
  "found": true,
  "selected": "admin",
  "matched": true,
  "interpretation": "Path 'user.roles[0]' -> \"admin\"; eq check passed."
}

Input schema

{
  "type": "object",
  "required": [
    "document",
    "path"
  ],
  "properties": {
    "document": {
      "type": "object",
      "examples": [
        {
          "user": {
            "roles": [
              "admin"
            ]
          }
        }
      ]
    },
    "path": {
      "type": "string",
      "examples": [
        "user.roles[0]"
      ]
    },
    "op": {
      "type": "string",
      "examples": [
        "eq"
      ]
    },
    "value": {
      "description": "Comparison value",
      "examples": [
        "admin"
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}