Skip to main content
POST
Create a workflow
Minimum role required: Member

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Body

application/json

Request body for creating a new workflow.

name
string
required

Human-readable workflow name.

Pattern: ^[A-Za-z0-9_-]+$
capture
boolean

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.

code
string

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

ocr_engine
enum<string>

OCR backend to use.

Available options:
free,
premium
platform
enum<string>

Target OS platform.

Available options:
ios,
android,
both
recording
boolean

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

telemetry
boolean

Emit telemetry for this workflow's runs (default true). false suppresses both live frames and durable trace storage.

Response

Created

Returned after successfully creating a workflow.

workflow_id
string
required

Identifier assigned to the new workflow.

revision
integer<int64>

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

revision_id
string

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