Sign in

v12

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

Update a workflow

Applies a partial update (name, platform, status, ocr_engine). Org-scoped — workflows in other orgs return 404.

put/workflows/{workflow_id}

Path parameters

workflow_idstring uuid required

workflow identifier

workflow identifier

Request body

$schemastring uri

A URL to the JSON Schema for this object.

namestring

Updated workflow name.

ocr_engine'free' | 'premium'

Updated OCR backend selection.

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

Updated target platform.

status'ready' | 'training' | 'running'

Updated lifecycle status.

Example request

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

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