job

run script by path

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

Path parameters

workspacestring required
pathstring required

Query parameters

parent_jobstring uuid

The parent job that is at the origin and responsible for the execution of this script if any

tagstring

Override the tag to use

cache_ttlstring

Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl

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)

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

skip_preprocessorboolean

skip the preprocessor

Request body

ScriptArgs required

The arguments to pass to the script or flow

Response

job result

unknown required

Changes

No recorded changes to this operation across all 304 revisions of this API.