Skip to main content
POST

Request Parameters

Body

string
required
The natural language prompt that will be translated to an SQL query. Minimum length: 10 characters
string
The database schema where the query will be run. Not required if file_store_key is specified.
enum
The database type to generate SQL for. Specifying this parameter improves SQL generation accuracy by applying database-specific syntax and optimizations.
  • postgresql - PostgreSQL database
  • mysql - MySQL database
  • sqlite - SQLite database
string
The key used to store the database schema on Jigsawstack file Storage. Not required if sql_schema is specified.
Either file_store_key or sql_schema can be provided not both.
string
required
Your JigsawStack API key

Response Structure

boolean
Indicates whether the call was successful.
object
Usage information for the API call.
string
A unique identifier for the request
string
The generated SQL query based on the natural language prompt and provided schema.