Skip to main content
POST
Create Workflow Run
Starts a new run for the specified workflow. The run is queued and processed asynchronously. Use the Get Run Status endpoint to poll for progress.

Parameters

string
required
Unique identifier for the workflow to run. Find this in the Slate dashboard under the workflow’s settings.
string
required
Bearer token. Format: Bearer slat_<your-token>.
string
Optional unique key to prevent duplicate runs. If you send the same key with the same workflowId, the API returns the existing run instead of creating a new one. A key reused with a different workflowId returns a 409 error.
object
required
Key-value pairs that map to the workflow’s input parameters. The required keys depend on the specific workflow.

Response

Returns 202 Accepted with the queued run details.
string
required
Unique identifier for the created run. Use this to poll status or cancel the run.
string
required
Initial status of the run. Always QUEUED for new runs.
number
Workspace ID assigned to the run. May be null until the run starts processing.
string
Internal execution ID. May be null until the run starts processing.
string
required
Relative URL to poll the run status. Append to the base URL to get the full path.

Example

Response

Status codes

Run lifecycle

After creation, a run progresses through these statuses:
  1. QUEUED — The run is waiting to be picked up.
  2. STARTING — The run is initializing (creating workspace, starting execution).
  3. RUNNING — The workflow is actively executing.
  4. COMPLETED — The workflow finished. Output is available via Get Run Status.
  5. FAILED — The workflow encountered an error. Check the error field for details.
  6. CANCELED — The run was canceled while queued.
You can only cancel a run while the status is QUEUED. Once a run moves to STARTING or later, cancellation is not possible.

What’s next