job

run script preview

Changed on
post/w/{workspace}/jobs/run/preview

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/jobs/run/preview
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

include_headerstring

List of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key

invisible_to_ownerboolean

make the run invisible to the the script owner (default false)

timeoutinteger

custom timeout in seconds for this preview run

job_idstring uuid

The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)

Request body

contentstring

The code to run

pathstring

The path to the script

script_hashstring

The hash of the script

argsScriptArgs required

The arguments to pass to the script or flow

language'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'rlang' | 'duckdb' | 'bunnative' | 'dbt'
tagstring
kind'code' | 'identity' | 'http'
dedicated_workerboolean
lockstring
flow_pathstring
modulesobject nullable

Additional script modules keyed by relative file path

temp_script_refsobject nullable

Map of relative-import script path -> temp storage hash so the preview job resolves those imports from not-yet-deployed local content instead of the deployed script

Response

job created

Changes

  • 33c26da1e324Revision changes
    • info

      added the new dbt enum value to the request property

    • info

      added the new dbt enum value to the request property //

  • 55a776f09d9eRevision changes
    • info

      added the new optional query request parameter timeout