> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindsdb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Query

## Description

This API provides a REST endpoint for executing the SQL queries. Note:

* This endpoint is a HTTP POST method.
* This endpoint accept data via `application/json` request body.
* The only required key is the `query` which has the SQL statement value.

### Body

<ParamField body="query" type="string" required>
  String that contains the SQL query that needs to be executed.
</ParamField>

<ParamField body="response_format" type="string">
  Format of the response. Available options:

  * `null` (default) - returns all data in a single JSON response
  * `"sse"` - returns data as Server-Sent Events stream
  * `"jsonlines"` - returns data as JSON Lines stream (one JSON object per line)

  Use `"sse"` or `"jsonlines"` for streaming large result sets to avoid loading all data into memory at once.
</ParamField>

<ParamField body="context" type="object">
  Optional context object, e.g., `{"db": "mindsdb"}` to specify the database.
</ParamField>

<ParamField body="params" type="object">
  Optional parameters for parameterized queries, e.g., `{"name": "value"}`.
</ParamField>

### Response

<ResponseField name="column_names" type="array" required>
  A list with the column names returned
</ResponseField>

<ResponseField name="context" type="object" required>
  The database where the query is executed
</ResponseField>

<ResponseField name="data" type="array">
  The actual data returned by the query in case of the table response type
</ResponseField>

<ResponseField name="type" type="string">
  The type of the response table | error | ok
</ResponseField>

<RequestExample>
  ```shell Shell theme={null}
  curl --request POST \
       --url https://cloud.mindsdb.com/api/sql/query \
       --header 'Content-Type: application/json' \
       --data '
  {
       "query": "SELECT * FROM example_db.demo_data.home_rentals LIMIT 10;"
  }
  '
  ```

  ```shell Shell (Streaming with SSE) theme={null}
  curl --request POST \
       --url https://cloud.mindsdb.com/api/sql/query \
       --header 'Content-Type: application/json' \
       --data '
  {
       "query": "SELECT * FROM example_db.demo_data.home_rentals;",
       "response_format": "sse"
  }
  '
  ```

  ```shell Shell (Streaming with JSON Lines) theme={null}
  curl --request POST \
       --url https://cloud.mindsdb.com/api/sql/query \
       --header 'Content-Type: application/json' \
       --data '
  {
       "query": "SELECT * FROM example_db.demo_data.home_rentals;",
       "response_format": "jsonlines"
  }
  '
  ```

  ```python Python theme={null}
  import requests
  url = 'https://cloud.mindsdb.com/api/sql/query'
  resp = requests.post(url, json={'query': 
                      'SELECT * FROM example_db.demo_data.home_rentals LIMIT 10;'})
  ```
</RequestExample>

<ResponseExample>
  ```json Response (Default) theme={null}
  {
      "column_names": [
          "sqft",
          "rental_price"
      ],
      "context": {
          "db": "mindsdb"
      },
      "data": [
          [
              917,
              3901
          ],
          [
              194,
              2042
          ]
      ],
      "type": "table"
  }
  ```

  ```text Response (SSE format) theme={null}
  data: {"type": "table", "column_names": ["sqft", "rental_price"], "context": {"db": "mindsdb"}}

  data: [[917, 3901], [194, 2042]]

  data: [[543, 1871], [289, 1563]]

  ```

  ```text Response (JSON Lines format) theme={null}
  {"type": "table", "column_names": ["sqft", "rental_price"], "context": {"db": "mindsdb"}}
  [[917, 3901], [194, 2042]]
  [[543, 1871], [289, 1563]]
  ```
</ResponseExample>