# Model Description

The Model Description section defines the standardized structure of API responses. It includes essential attributes that encapsulate core data, summaries, metadata, and error handling. This ensures consistency and clarity when integrating with the API.

| Field      | Type                   | Description                                                                                                 |
| ---------- | ---------------------- | ----------------------------------------------------------------------------------------------------------- |
| `data`     | Data object            | Represents the core response payload                                                                        |
| `summary`  | Map\<string, object>   | Contains a summary of the core response data                                                                |
| `metadata` | Metadata object        | Provides additional context about the response, such as pagination details, versioning, and extra metadata. |
| `error`    | Error object, nullable | Detailed information if the request encounters an error, including error codes and descriptive messages.    |


---

# Agent Instructions: 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:

```
GET https://docs.rateparity.com/model.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.