> For the complete documentation index, see [llms.txt](https://docs.jetadmin.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.jetadmin.io/user-guide/sql-queries-and-api-requests/api-builder/choose-api-response-format.md).

# Choose an API response format

Choose JSON, XML, Text, or Blob to match an endpoint response.

Match the response format to the data returned by the endpoint.

| Format | Use for                                      |
| ------ | -------------------------------------------- |
| JSON   | Objects and arrays, such as customer records |
| XML    | Structured XML responses                     |
| Text   | Plain text, logs, or messages                |
| Blob   | Binary responses, such as files              |

## Configure and check the response

1. Test the endpoint and inspect its returned content.
2. Choose the response format matching that content.
3. Preview the result and confirm that the expected values are available.
4. For a JSON list nested inside an object, select its root and map the fields using [Transform API responses](/user-guide/sql-queries-and-api-requests/api-builder/transform-api-responses.md).

<figure><img src="https://3448227606-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LQ08RFAKZvFADEiXKFy%2Fuploads%2FiTqdBE23qjjCQRbfSKkT%2Fimage.png?alt=media&#x26;token=bab07c0b-5a8c-4a14-9120-e2f46ec3184b" alt="API Builder response format options"><figcaption></figcaption></figure>

A response format controls how content is handled. It does not rename fields or select a nested list; those are transformation tasks.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.jetadmin.io/user-guide/sql-queries-and-api-requests/api-builder/choose-api-response-format.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.