> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/json/query.md).

# Query

Task version: 1.3.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.JSON>

## Task Parameters

{% tabs %}
{% tab title="Input" %}

| Name             | Description                                                                                                                                                           |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Json : `Object`  | <p>Json input needs to be of type string or JToken</p><p><br>Default: <code>-</code><br>Example: <code>{"key":"value"}</code></p>                                     |
| Query : `String` | <p>The query is of type JSONPath.</p><p>More details: <http://goessner.net/articles/JsonPath/></p><p><br>Default: <code>-</code><br>Example: <code>"$.key"</code></p> |
| {% endtab %}     |                                                                                                                                                                       |

{% tab title="Options" %}

| Name                             | Description                                                                                                                                                                                |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ErrorWhenNotMatched : `Boolean`  | <p>A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p> |
| ThrowErrorOnFailure : `Boolean`  | <p>If true, exceptions are thrown on failure. If false, errors are returned as part of the result.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                  |
| ErrorMessageOnFailure : `String` | <p>Custom error message to use when an error occurs. Leave empty to use the original exception message.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                   |
| {% endtab %}                     |                                                                                                                                                                                            |
| {% endtabs %}                    |                                                                                                                                                                                            |

## Task Result

| Name                         | Description                                                                        |
| ---------------------------- | ---------------------------------------------------------------------------------- |
| Success : `Boolean`          | <p>Operation complete without errors.<br>Example: <code>true</code></p>            |
| Data : `IEnumerable<Object>` | <p>Result data.<br>Example: <code>\[ { Foo }, { Bar } ]</code></p>                 |
| Error : `Error`              | Error information, populated when the task fails and ThrowErrorOnFailure is false. |

## Task Changelog

Changelog is not available for this Task.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.frends.com/tasks/tasks/json/query.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
