API Documentation

Endpoint:

/query

Method:

POST

Headers:

X-API-Key: your_api_key
Content-Type: application/json

Request Body:

{
    "markdown_text": "Your SQL query in markdown format",
    "response_format": "json"  // Optional, defaults to "json". Can be "json", "markdown", or "csv"
}

Response Format:

// For JSON format (default):
{
    "code": 200,
    "message": "success",
    "data": [
        // Query results as JSON array
    ]
}

// For Markdown format:
{
    "code": 200,
    "message": "success",
    "data": "| Column1 | Column2 |\n|---------|----------|\n| value1  | value2   |"
}

// For CSV format:
{
    "code": 200,
    "message": "success",
    "data": "Column1,Column2\nvalue1,value2"
}

Test API

Response:

No results yet