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

# Object Response

The Object response is a configurable JSON response for your agent. This ensures a predictable response format from your agent.&#x20;

Functions are not available on Object Responses as they are returned on every api call.&#x20;

You can configure your object response parameters on your agent configuration form as seen below.

<figure><img src="/files/tZ7cB4cpRgWSgjBV0DDe" alt=""><figcaption></figcaption></figure>

Each parameter data type can be String, Number or Boolean. A parameter name  and parameter description is required. For example, an agent meant to classify movies in genre would have a configuration like so: &#x20;

Name: Class\
Description: The genre of the movie \
Type: String&#x20;

Below is a sample response from a diagnosis fraud analysis agent

```json
{
    "message": {
        "id": "duH7f5mOItDIlpYRbMPDE",
        "role": "assistant",
        "content": {
            "fraud": false,
            "comment": "The diagnosis of Pediculus Capitis (head lice) is a valid medical condition. The details provided do not indicate any fraudulent activity."
        }
    }
}
```

\
The parameters from the above response are fraud (string) and comment (string).

{% hint style="info" %}
Object responses do not allow functions and hence non-long running.  Agent responses are returned on every requests. Your configured parameters are returned as the "content" response object.
{% endhint %}


---

# 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.vorsto.io/api/object.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.
