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.

By default, the open source version doesn’t provide Authentication methods as MindsDB Cloud. On MindsDB cloud you need to set the cookie field in the header of request e.g {session=273trgsehgrui3i2riurwehe}.

Body

query · string · required

String that contains the SQL query that needs to be executed.

Response

column_names · array · required

A list with the column names returned

context · object · required

The database where the query is executed

data · array

The actual data returned by the query in case of the table response type

type · string

The type of the response table | error | ok

Shell

curl --request POST \
     --url https://cloud.mindsdb.com/api/sql/query \
     --header 'Content-Type: application/json' \
     --cookie '{session=273trgsehgrui3i2riurwehe}'\
     --data '
{
     "query": "SELECT * FROM example_db.demo_data.home_rentals LIMIT 10;"
}

Response

{
    "column_names": [
        "sqft",
        "rental_price"
    ],
    "context": {
        "db": "mindsdb"
    },
    "data": [
        [
            917,
            3901
        ],
        [
            194,
            2042
        ]
    ],
    "type": "table"
    }