Sign in

v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-065499150.5 KB
workflows

Create a workflow

Creates a workflow in the caller's org. Name must match ^[A-Za-z0-9_-]+$ and be unique within the org. Pass code to save the workflow's first code revision atomically with it; omit it to create an empty workflow and add code later. Returns the workflow_id (plus revision_id and revision when code was provided).

post/workflows

Request body

$schemastring uri

A URL to the JSON Schema for this object.

captureboolean

Capture media this workflow's runs produce on the phone into the org's file library (default true). false disables capture for every run dispatched through the scheduler.

codestring

Optional Python source for the workflow's first revision, saved atomically with the workflow when provided.

namestring required

Human-readable workflow name.

ocr_engine'free' | 'premium'

OCR backend to use.

platform'ios' | 'android' | 'both'

Target OS platform.

recordingboolean

Record this workflow's runs (default true). false suppresses video recording and the rolling thumbnail entirely, for every run dispatched through the scheduler.

telemetryboolean

Persist telemetry spans for this workflow's runs (default true). false skips the durable trace store; the live telemetry stream still works while a run is active.

Example request

{
  "$schema": "/api/v1/WorkflowCreateRequest.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

revisioninteger

Revision number of the first code revision (1), when code was provided.

revision_idstring

Id of the first code revision, when code was provided.

workflow_idstring required

Identifier assigned to the new workflow.

Example response

{
  "$schema": "/api/v1/WorkflowCreateResponse.json"
}