> ## Documentation Index
> Fetch the complete documentation index at: https://docs.e6data.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Validate workload

> validate workload. POST /api/v1/workloads/validate. Validate a workload. Batch Python is not executed. Explicit Streaming Python runs as trusted code to capture its streaming plan,

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json POST /api/v1/workloads/validate
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/workloads/validate:
    post:
      tags:
        - Workloads
      summary: validate workload
      description: >-
        validate workload. POST /api/v1/workloads/validate. Validate a workload.
        Batch Python is not executed. Explicit Streaming Python runs as trusted
        code to capture its streaming plan, so streaming validation is an
        execution action.
      operationId: validate_workload
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Input_app_api_src_models_rs_WorkloadCreateRequest
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/kernel_scheduler_src_workloads_model_rs_WorkloadValidationResponse
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    Input_app_api_src_models_rs_WorkloadCreateRequest:
      additionalProperties: false
      properties:
        dependencies:
          items:
            $ref: '#/components/schemas/Input_shared_common_src_lib_rs_TaskDependency'
          type: array
        name:
          anyOf:
            - type: string
            - type: 'null'
        options:
          $ref: >-
            #/components/schemas/Input_shared_common_src_lib_rs_WorkloadSubmissionOptions
        parameters:
          additionalProperties:
            $ref: >-
              #/components/schemas/Input_shared_common_src_parameters_rs_ParameterDefinition
          type: object
        policy:
          $ref: >-
            #/components/schemas/Input_kernel_scheduler_src_scheduling_model_rs_SchedulingPolicy
        submission_id:
          $ref: '#/components/schemas/Input_shared_common_src_lib_rs_SubmissionId'
        tasks:
          items:
            $ref: '#/components/schemas/Input_app_api_src_models_rs_SqlTask'
          type: array
        workflow:
          $ref: >-
            #/components/schemas/Input_shared_common_src_workflow_rs_WorkflowOptions
      required:
        - submission_id
        - tasks
        - policy
      type: object
    kernel_scheduler_src_workloads_model_rs_WorkloadValidationResponse:
      properties:
        task_count:
          minimum: 0
          type: integer
        valid:
          type: boolean
        validation:
          type: string
      required:
        - valid
        - validation
        - task_count
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    Input_shared_common_src_lib_rs_TaskDependency:
      properties:
        downstream:
          type: string
        input_name:
          anyOf:
            - type: string
            - type: 'null'
        upstream:
          type: string
      required:
        - upstream
        - downstream
      type: object
    Input_shared_common_src_lib_rs_WorkloadSubmissionOptions:
      properties:
        compute_requirements:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_ComputeRequirements
            - type: 'null'
        deployment_profile:
          anyOf:
            - type: string
            - type: 'null'
        execution_target:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_ExecutionTarget
            - type: 'null'
        execution_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        max_attempts:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        missed_run_policy:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_MissedRunPolicy
            - type: 'null'
        overlap_policy:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_OverlapPolicy
            - type: 'null'
        parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
          description: Maximum assigned tasks in one run. Unset has no run limit.
        profile:
          anyOf:
            - type: string
            - type: 'null'
        provisioner:
          anyOf:
            - type: string
            - type: 'null'
        queue_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        start_paused:
          type: boolean
        worker_scope:
          anyOf:
            - $ref: '#/components/schemas/Input_shared_common_src_lib_rs_WorkerScope'
            - type: 'null'
        xray:
          type: boolean
      required: []
      type: object
    Input_shared_common_src_parameters_rs_ParameterDefinition:
      additionalProperties: false
      properties:
        default:
          anyOf:
            - description: JSON value; fields depend on the enclosing document or provider.
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
        enum:
          anyOf:
            - items:
                description: >-
                  JSON value; fields depend on the enclosing document or
                  provider.
              type: array
            - type: 'null'
        nullable:
          type: boolean
        required:
          type: boolean
        type:
          $ref: >-
            #/components/schemas/Input_shared_common_src_parameters_rs_ParameterType
      required:
        - type
      type: object
    Input_kernel_scheduler_src_scheduling_model_rs_SchedulingPolicy:
      oneOf:
        - const: Manual
          type: string
        - const: Immediately
          type: string
        - properties:
            At:
              properties:
                at:
                  $ref: >-
                    #/components/schemas/Input_shared_common_src_time_rs_WallClockTimestamp
              required:
                - at
              type: object
          required:
            - At
          type: object
        - properties:
            Interval:
              properties:
                every:
                  properties:
                    nanos:
                      maximum: 999999999
                      minimum: 0
                      type: integer
                    secs:
                      minimum: 0
                      type: integer
                  required:
                    - secs
                    - nanos
                  type: object
                start_at:
                  $ref: >-
                    #/components/schemas/Input_shared_common_src_time_rs_WallClockTimestamp
              required:
                - start_at
                - every
              type: object
          required:
            - Interval
          type: object
        - properties:
            Cron:
              properties:
                expression:
                  type: string
                timezone:
                  type: string
              required:
                - expression
                - timezone
              type: object
          required:
            - Cron
          type: object
    Input_shared_common_src_lib_rs_SubmissionId:
      format: uuid
      type: string
    Input_app_api_src_models_rs_SqlTask:
      allOf:
        - $ref: >-
            #/components/schemas/Input_shared_common_src_execution_mod_rs_ExecutionOptions
        - properties:
            control:
              $ref: >-
                #/components/schemas/Input_shared_common_src_workflow_rs_TaskControl
            incremental_source:
              anyOf:
                - $ref: >-
                    #/components/schemas/Input_shared_common_src_lib_rs_IncrementalSource
                - type: 'null'
            name:
              type: string
            python:
              anyOf:
                - type: string
                - type: 'null'
            python_mode:
              anyOf:
                - $ref: >-
                    #/components/schemas/Input_app_api_src_models_rs_PythonTaskMode
                - type: 'null'
            settings:
              $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_QuerySettings
            spark_plan:
              anyOf:
                - type: string
                - type: 'null'
            sql:
              type: string
          required:
            - name
            - settings
          type: object
    Input_shared_common_src_workflow_rs_WorkflowOptions:
      additionalProperties: false
      properties:
        data_windows:
          type: boolean
        notifications:
          items:
            $ref: >-
              #/components/schemas/Input_shared_common_src_workflow_rs_NotificationSubscription
          type: array
      required: []
      type: object
    Input_shared_common_src_lib_rs_ComputeRequirements:
      properties:
        cpu_millicores:
          minimum: 1
          type: integer
        memory_bytes:
          minimum: 1
          type: integer
        tuning:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_compute_rs_ComputeTuning
            - type: 'null'
      required:
        - cpu_millicores
        - memory_bytes
      type: object
    Input_shared_common_src_lib_rs_ExecutionTarget:
      oneOf:
        - const: DataFusion
          type: string
        - const: DuckDb
          type: string
    Input_shared_common_src_lib_rs_MissedRunPolicy:
      oneOf:
        - const: RunOnce
          type: string
        - const: RunAll
          type: string
        - const: Skip
          type: string
    Input_shared_common_src_lib_rs_OverlapPolicy:
      oneOf:
        - const: Wait
          type: string
        - const: Skip
          type: string
        - const: Allow
          type: string
    Input_shared_common_src_lib_rs_WorkerScope:
      oneOf:
        - const: Task
          type: string
        - const: Workload
          type: string
        - const: Deployment
          type: string
    Input_shared_common_src_parameters_rs_ParameterType:
      oneOf:
        - const: string
          type: string
        - const: string_array
          type: string
        - const: integer
          type: string
        - const: decimal
          type: string
        - const: boolean
          type: string
        - const: date
          type: string
        - const: timestamp
          type: string
    Input_shared_common_src_time_rs_WallClockTimestamp:
      properties:
        unix_millis:
          type: integer
      required:
        - unix_millis
      type: object
    Input_shared_common_src_execution_mod_rs_ExecutionOptions:
      properties:
        compute_requirements:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_ComputeRequirements
            - type: 'null'
        deployment_profile:
          anyOf:
            - type: string
            - type: 'null'
        profile:
          anyOf:
            - type: string
            - type: 'null'
        provisioner:
          anyOf:
            - type: string
            - type: 'null'
        worker_scope:
          anyOf:
            - $ref: '#/components/schemas/Input_shared_common_src_lib_rs_WorkerScope'
            - type: 'null'
        xray:
          type: boolean
      required: []
      type: object
    Input_shared_common_src_workflow_rs_TaskControl:
      additionalProperties: false
      properties:
        retry:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_workflow_rs_RetryPolicy
            - type: 'null'
        sensor:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_workflow_rs_SensorSpec
            - type: 'null'
      required: []
      type: object
    Input_shared_common_src_lib_rs_IncrementalSource:
      properties:
        branch:
          type: string
        table:
          $ref: '#/components/schemas/Input_shared_common_src_lib_rs_TableReference'
      required:
        - table
        - branch
      type: object
    Input_app_api_src_models_rs_PythonTaskMode:
      oneOf:
        - const: Batch
          type: string
        - const: Streaming
          type: string
    Input_shared_common_src_lib_rs_QuerySettings:
      properties:
        ansi_enabled:
          type: boolean
        case_sensitive:
          type: boolean
        current_catalog:
          type: string
        namespace:
          items:
            type: string
          type: array
        time_zone:
          type: string
      required:
        - current_catalog
        - namespace
        - time_zone
        - case_sensitive
        - ansi_enabled
      type: object
    Input_shared_common_src_workflow_rs_NotificationSubscription:
      additionalProperties: false
      properties:
        channel:
          $ref: >-
            #/components/schemas/Input_shared_common_src_workflow_rs_NotificationChannel
        events:
          items:
            $ref: >-
              #/components/schemas/Input_shared_common_src_workflow_rs_WorkflowEventKind
          type: array
        max_attempts:
          minimum: 0
          type: integer
        name:
          type: string
      required:
        - name
        - channel
        - events
      type: object
    Input_shared_common_src_compute_rs_ComputeTuning:
      additionalProperties: false
      properties:
        batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        file_read_concurrency:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        input_prefetch_batches:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        native_parquet_scan:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            False always uses connector-produced Arrow batches. Omitted keeps
            the native Parquet capability enabled when the source can supply it
            safely.
        output_buffer_batches:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        query_memory_bytes:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        spill_bytes:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: >-
            Zero disables disk spill. The directory is controlled by the
            deployment.
        threads:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
      required: []
      type: object
    Input_shared_common_src_workflow_rs_RetryPolicy:
      additionalProperties: false
      properties:
        backoff:
          $ref: '#/components/schemas/Input_shared_common_src_workflow_rs_Backoff'
        initial_delay_seconds:
          minimum: 0
          type: integer
        jitter_percent:
          description: >-
            Deterministic spread, derived from the saved task identity and
            attempt.
          minimum: 0
          type: integer
        max_attempts:
          minimum: 0
          type: integer
        max_delay_seconds:
          minimum: 0
          type: integer
        python_replay_safe:
          type: boolean
      required:
        - max_attempts
      type: object
    Input_shared_common_src_workflow_rs_SensorSpec:
      additionalProperties: false
      properties:
        condition:
          $ref: >-
            #/components/schemas/Input_shared_common_src_workflow_rs_SensorCondition
        poll_interval_seconds:
          minimum: 0
          type: integer
        timeout_seconds:
          minimum: 0
          type: integer
      required:
        - condition
        - timeout_seconds
      type: object
    Input_shared_common_src_lib_rs_TableReference:
      properties:
        catalog_id:
          $ref: '#/components/schemas/Input_shared_common_src_lib_rs_CatalogId'
        name:
          type: string
        namespace:
          items:
            type: string
          type: array
      required:
        - catalog_id
        - namespace
        - name
      type: object
    Input_shared_common_src_workflow_rs_NotificationChannel:
      oneOf:
        - allOf:
            - properties:
                kind:
                  const: webhook
              required:
                - kind
              type: object
            - properties:
                secret:
                  anyOf:
                    - type: string
                    - type: 'null'
                url:
                  type: string
              required:
                - url
              type: object
        - allOf:
            - properties:
                kind:
                  const: slack
              required:
                - kind
              type: object
            - properties:
                secret:
                  anyOf:
                    - type: string
                    - type: 'null'
                url:
                  type: string
              required:
                - url
              type: object
    Input_shared_common_src_workflow_rs_WorkflowEventKind:
      oneOf:
        - const: run_started
          type: string
        - const: run_succeeded
          type: string
        - const: run_failed
          type: string
        - const: run_cancelled
          type: string
        - const: outcome_unknown
          type: string
        - const: task_retry
          type: string
        - const: task_failed
          type: string
        - const: sensor_timeout
          type: string
        - const: backfill_completed
          type: string
        - const: backfill_failed
          type: string
    Input_shared_common_src_workflow_rs_Backoff:
      oneOf:
        - const: fixed
          type: string
        - const: exponential
          type: string
    Input_shared_common_src_workflow_rs_SensorCondition:
      oneOf:
        - allOf:
            - properties:
                kind:
                  const: object_exists
              required:
                - kind
              type: object
            - properties:
                url:
                  type: string
              required:
                - url
              type: object
        - allOf:
            - properties:
                kind:
                  const: http
              required:
                - kind
              type: object
            - properties:
                expected_status:
                  minimum: 0
                  type: integer
                expected_value:
                  anyOf:
                    - type: string
                    - type: 'null'
                json_pointer:
                  anyOf:
                    - type: string
                    - type: 'null'
                secret:
                  anyOf:
                    - type: string
                    - type: 'null'
                url:
                  type: string
              required:
                - url
                - expected_status
              type: object
        - allOf:
            - properties:
                kind:
                  const: workload_run
              required:
                - kind
              type: object
            - properties:
                run_id:
                  $ref: >-
                    #/components/schemas/Input_shared_common_src_lib_rs_WorkloadRunId
                workload_id:
                  $ref: >-
                    #/components/schemas/Input_shared_common_src_lib_rs_WorkloadId
              required:
                - workload_id
                - run_id
              type: object
    Input_shared_common_src_lib_rs_CatalogId:
      format: uuid
      type: string
    Input_shared_common_src_lib_rs_WorkloadRunId:
      format: uuid
      type: string
    Input_shared_common_src_lib_rs_WorkloadId:
      format: uuid
      type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.