Sign in
Pipeline Lifecycle

Validate Program

Required role: write or higher.

Validate a SQL program by compiling it, without creating a pipeline or building the pipeline binary. Reports SQL errors and warnings and the derived schema and connectors. Set ir to also return the program IR (dataflow).

Note that this endpoint returns HTTP 200, regardless of whether validation succeeds or fails. The validation result, including any compiler warnings and errors, is encoded in the ValidateProgramResponse response body.

post/v0/validate_program

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

irboolean

Return the program IR (dataflow) in the response. false by default; most callers only need to know whether the program is valid.

program_codestring required

SQL program code to validate.

runtime_versionstring nullable

Runtime version to compile with: a version tag (vX.Y.Z) or a 40-character git SHA. If omitted, the platform's default runtime is used.

Response

Validation completed; the body reports success, SQL errors, or a system error

OR
OR

Changes

No recorded changes to this operation across all 51 revisions of this API.