Skip to main content

CreateRun

POST 
/api/v1/workspaces/:workspace_id/runs

Triggers a new run for a script in a workspace. The latest script version will be used. The profile associated with the script version will be used, of which the latest profile_version will be used. You may specify a specific profile to use.

The script can be identified by ID, name, or public_secret UUID. When using public_secret, the profile setting is ignored and the default profile is used.

Anonymous users (no auth header) can only create runs using a script's public_secret. Authenticated users can use ID, name, or public_secret.

The mode parameter controls run creation behavior:

  • 'always' (default): Always creates a new run
  • 'when_not_running': Returns an existing active run if one exists, otherwise creates a new one

Requires WRITE permission on the organization level (or public_secret for anonymous access).

Request​

Responses​

Document created, URL follows

Response Headers