client.workflows lists your workflows (list, list_page) and is the workflow builder; client.folders lists the folders that organize them. See List workflows and List folders. The builder: you describe a workflow as a plan (name, trigger, steps), look up what the plan may name, dry-run it with compile, and write it with create or update. It wraps the /v1/workflows* endpoints - the plan’s full shape is in the API reference.
List workflows
stepsCount) with no steps. Read one back as a plan with get_plan / getPlan.
listwith notopdrains every match, 100 per page. Passtopfor one bounded page (server cap 100), andoffsetwith it to read a later one.offsetwithouttopraisesEnginiClientError.list_page/listPagereturns one page withtotal_count/totalCount.- A workflow deleted while
listis draining can still be skipped. - Table automations are not listed. A workspace-scoped API key sees only its own workspace and environment; see API keys.
List folders
client.folders lists workflow folders (it always sends type=workflow; table folders are not served). Each folder has id (a string), name, workspaceId, environmentId and itemsCount. Folder names are unique only within one workspace and environment, so two folders can share a name: check workspaceId and environmentId.
Look up what a plan may use
These are reads. Reading a schema with a connection (
connection_id / connectionId) is rate limited per key.
Dry-run, then write
compileanswers200even when the plan has errors: the result carrieshas_errors/hasErrorsand every diagnostic. Passbase_workflow_id/baseWorkflowIdto compile the plan as an edit of a saved workflow.createraisesEnginiBuilderErrorwith codePLAN_HAS_ERRORS(HTTP 422, the diagnostics on the error) for a plan with errors, and writes nothing. It returnsworkflow_id,designer_url,revision_id,diagnostics,workspace_id,environment_idand, for a manual-webhook trigger,webhook_url.- A Python plan may be a
WorkflowPlanor the equivalent dict. A malformed dict raisesEnginiClientErrorbefore any request is sent.
Edit a saved workflow
get_plan returns the plan plus a revisionId (an opaque token that moves on every write) and, for a manual-webhook trigger, webhookUrl. The plan reader ignores both extra members, so the body can be sent back as the plan unchanged. Pass the revisionId you read as expected_revision_id / expectedRevisionId so a stale save is refused instead of overwriting someone else’s edit.
Handle refusals
Every builder refusal is anEnginiBuilderError (a subclass of EnginiAPIError). It is mapped from the response body - its code - not from the status, so a builder 409 is not an EnginiConflictError: branch on code.