job

run flow preview

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

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_flow
  • 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)

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)

memory_idstring

Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.

Request body

valueFlowValue required(unresolved $ref)
pathstring
argsScriptArgs required

The arguments to pass to the script or flow

tagstring
temp_script_refsobject nullable

Map of relative-import script path -> temp storage hash, propagated to each flow step so inline-script relative imports resolve from not-yet-deployed local content instead of the deployed script

Response

job created

Changes