job

run flow by path and stream updates via SSE

Changed on
post/w/{workspace}/jobs/run_and_stream/f/{path}

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_and_stream/f/{path}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
pathstring 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

queue_limitstring

The maximum size of the queue for which the request would get rejected if that job would push it above that limit

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)

skip_preprocessorboolean

skip the preprocessor

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.

poll_delay_msinteger

delay between polling for job updates in milliseconds

Request body

ScriptArgs required

The arguments to pass to the script or flow

Response

server-sent events stream of job updates

Changes