POST data

json_query

1 credit

Query JSON with a JMESPath expression

Endpoint

POST /api/v1/tools/data/json_query

Body Parameters

text string required

expression string required

Example

input Request

{
    "text": "{\"users\": [{\"name\": \"Alice\"}, {\"name\": \"Bob\"}]}",
    "expression": "users[].name"
}

output Response

{
    "result": [
        "Alice",
        "Bob"
    ]
}

Response Format

HTTP/1.1 200 OK SUCCESS

{
  "success": true,
  "data": {
    "result": [
        "Alice",
        "Bob"
    ]
},
  "meta": {
    "tool": "json_query",
    "credits_consumed": 1
  }
}

HTTP/1.1 422 Unprocessable Entity ERROR

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid."
  }
}

Code Examples

Request Example

lightbulb Developer Tip

Credits are deducted before execution. If the upstream tool fails, credits are automatically refunded to your account.