job

run flow preview and wait for result

Changed on
post/w/{workspace}/jobs/run_wait_result/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_wait_result/preview_flow
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

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

on_behalf_ofstring nullable

Run the preview as this identity (an email, u/<username> or g/<group>) instead of the caller. Naming anyone other than yourself requires being an admin or a member of wm_deployers.

Response

job result

unknown required

Changes