Skip to main content
POST
code.sql.explain

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
sql
string
required

Sql.

Required string length: 1 - 20000

Response

The result

sqlLength
number
required

Sql length.

dialect
string

Dialect.

explanation
string

Explanation.

optimizationSuggestions
string[]

Optimization suggestions.

potentialIssues
string[]

Potential issues.

steps
string[]

Steps.

plainEnglish
string

Plain english.