Create a workflow

A workflow name can contain letters, digits, hyphens, and underscores. It must be unique inside the organization.

Create the workflow

Dashboard
CLI
Python SDK
Go SDK
REST API

From the workflow editor:

Open Workflows and choose your organization.
Click Create A Workflow, enter a unique name, then click Create Workflow.

Replace the Android starter source with this code:

driver.locator(query="the search box").fill("axilio")
driver.get_by_text("Search").tap()

Click Allocate Phone. Run individual blocks from the editor gutter while you iterate.
Click Save.

You can also turn code from a live session into a workflow. Open Sessions, select the active session, open Code, enter and run the same source, then click Save as workflow and give it a unique name.

cat > workflow.py <<'PY'
driver.locator(query="the search box").fill("axilio")
driver.get_by_text("Search").tap()
PY

axilio workflows create search-flow \
  --platform android \
  --code workflow.py

Passing --code saves the file atomically as revision 1. Omit it to create an empty workflow.

from axilio.platform import Client

client = Client()
source = """\
driver.locator(query="the search box").fill("axilio")
driver.get_by_text("Search").tap()
"""

created = client.workflows.create(
    name="search-flow",
    platform="android",
    code=source,
)
print(created.workflow_id, created.revision)

source := `driver.locator(query="the search box").fill("axilio")
driver.get_by_text("Search").tap()
`

created, err := api.Workflows.Create(ctx, &platformgo.WorkflowCreateRequest{
    Name:     "search-flow",
    Platform: platformgo.WorkflowCreateRequestPlatformAndroid.Ptr(),
    Code:     platformgo.String(source),
})
if err != nil {
    log.Fatal(err)
}
fmt.Println(created.WorkflowID)

REST API References:

Create a workflow: POST /workflows

Examples use Bash. To run them in PowerShell, see Run the curl examples on Windows.

cat > workflow.py <<'PY'
driver.locator(query="the search box").fill("axilio")
driver.get_by_text("Search").tap()
PY

jq -n --rawfile code workflow.py \
  '{name:"search-flow", platform:"android", code:$code}' |
  curl --silent --show-error --fail-with-body \
    --request POST \
    --url https://api.axilio.ai/api/v1/workflows \
    --header "X-Axilio-Api-Key: $AXILIO_API_KEY" \
    --header "Content-Type: application/json" \
    --data-binary @-

Axilio pre-binds driver and Key to the phone allocated for a hosted run or Dashboard editor session. Do not allocate another phone inside saved workflow source. Select the dedicated phone when you queue the run. Recording, Telemetry, and file capture default to enabled. Set recording=false to suppress video, telemetry=false to suppress both live and archived Telemetry, or capture=false to skip session file capture for every run.

Pull and save code

Dashboard
CLI
Python SDK
Go SDK
REST API

Open Workflows and click Edit for the workflow.
Edit the current source in the code editor.
Click Save to create a revision. Saving unchanged source is a no-op.

The Code tab of a workflow-linked live session provides the same Save action. The saved source applies to the next run, not the session already in progress.

axilio workflows pull wf_123 --out workflow.py
# Edit workflow.py.
axilio workflows push wf_123 workflow.py --message "handle sign-in"

current = client.workflows.get_code("wf_123")
print(current.revision, current.source)

saved = client.workflows.save_code(
    "wf_123",
    source=open("workflow.py", encoding="utf-8").read(),
    message="handle sign-in",
)
print(saved.revision, saved.no_op)

current, err := api.Workflows.GetCode(ctx, &platformgo.WorkflowsGetCodeRequest{
    WorkflowID: "wf_123",
})

saved, err := api.Workflows.SaveCode(ctx, &platformgo.WorkflowSaveCodeRequest{
    WorkflowID: "wf_123",
    Source:     string(sourceBytes),
    Message:    platformgo.String("handle sign-in"),
})

REST API References:

Get current workflow code: GET /workflows/{workflow_id}/code
Save workflow code: POST /workflows/{workflow_id}/code

Examples use Bash. To run them in PowerShell, see Run the curl examples on Windows.

curl --silent --show-error --fail-with-body \
  --url https://api.axilio.ai/api/v1/workflows/wf_123/code \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY"

jq -n --rawfile source workflow.py \
  --arg message "handle sign-in" \
  '{source:$source, message:$message}' |
  curl --silent --show-error --fail-with-body \
    --request POST \
    --url https://api.axilio.ai/api/v1/workflows/wf_123/code \
    --header "X-Axilio-Api-Key: $AXILIO_API_KEY" \
    --header "Content-Type: application/json" \
    --data-binary @-

Saving the same content is a no-op. Source is limited to 256 KiB.

Inspect or restore revisions

Restoring never deletes history. Axilio copies the selected source into a new revision so the action remains auditable.

Dashboard
CLI
Python SDK
Go SDK
REST API

Open Workflows and click Edit for the workflow.
Open Revision history in the right tool rail.
Select a revision to inspect its source in the read-only preview.
Click Restore this revision, then click Confirm.

The restored source becomes a new revision. Existing history remains.

axilio workflows revisions wf_123
axilio workflows restore wf_123 rev_456

history = client.workflows.list_revisions("wf_123", limit=20)
for revision in history.revisions or []:
    print(revision.revision, revision.id, revision.message)

client.workflows.restore_revision("wf_123", revision_id="rev_456")

history, err := api.Workflows.ListRevisions(
    ctx,
    &platformgo.WorkflowsListRevisionsRequest{
        WorkflowID: "wf_123",
        Limit:      platformgo.Int64(20),
    },
)

restored, err := api.Workflows.RestoreRevision(
    ctx,
    &platformgo.WorkflowRestoreRevisionRequest{
        WorkflowID: "wf_123",
        RevisionID: "rev_456",
    },
)

REST API References:

List workflow revisions: GET /workflows/{workflow_id}/revisions
Restore a workflow revision: POST /workflows/{workflow_id}/code/restore

Examples use Bash. To run them in PowerShell, see Run the curl examples on Windows.

curl --silent --show-error --fail-with-body \
  --url "https://api.axilio.ai/api/v1/workflows/wf_123/revisions?limit=20" \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY"

curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.axilio.ai/api/v1/workflows/wf_123/code/restore \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"revision_id":"rev_456"}'

Get Started

Phones and Sessions

Workflows and Runs

Files

Observability

Telemetry

Usage

Billing

Organization

Reference

Create a workflow

Create the workflow

Pull and save code

Inspect or restore revisions

Next steps

Run the workflow

Monitor runs

​Create the workflow

​Pull and save code

​Inspect or restore revisions

​Next steps

Run the workflow

Monitor runs

Create the workflow

Pull and save code

Inspect or restore revisions

Next steps