# Workflow Object

> Source: https://elaichi.ai/docs/api-reference/workflows/automation/

Schema for the `Workflow` resource in **Workflows**.

_No documented properties._

## Methods

- [GET /automation](/docs/api-reference/workflows/automation/listautomations) — List workflows
- [POST /automation](/docs/api-reference/workflows/automation/createautomation) — Create a workflow
- [GET /automation/examples](/docs/api-reference/workflows/automation/listautomationexamples) — Suggested workflows for the caller
- [POST /automation/validate](/docs/api-reference/workflows/automation/validatenewautomationdefinition) — Validate a definition before creating a workflow
- [GET /automation/{id}](/docs/api-reference/workflows/automation/getautomation) — Get a workflow
- [PATCH /automation/{id}](/docs/api-reference/workflows/automation/updateautomation) — Update a workflow's name, description or enabled switch
- [DELETE /automation/{id}](/docs/api-reference/workflows/automation/deleteautomation) — Delete a workflow
- [PUT /automation/{id}/draft](/docs/api-reference/workflows/automation/saveautomationdraft) — Save a workflow draft
- [POST /automation/{id}/draft/discard](/docs/api-reference/workflows/automation/discardautomationdraft) — Throw the draft away and go back to the live version
- [GET /automation/{id}/draft/head](/docs/api-reference/workflows/automation/getautomationdrafthead) — The draft's current revision
- [POST /automation/{id}/validate](/docs/api-reference/workflows/automation/validateautomation) — Validate this workflow's draft (or a candidate definition)
- [POST /automation/{id}/publish](/docs/api-reference/workflows/automation/publishautomation) — Publish the workflow's current draft
- [GET /automation/{id}/version](/docs/api-reference/workflows/automation/listautomationversions) — List a workflow’s published versions
- [GET /automation/{id}/version/{vid}](/docs/api-reference/workflows/automation/getautomationversion) — Get one published version, including its full definition
- [POST /automation/{id}/version/{vid}/republish](/docs/api-reference/workflows/automation/republishautomationversion) — Re-publish an older version as the new latest version
- [POST /automation/{id}/enable](/docs/api-reference/workflows/automation/enableautomation) — Enable a workflow
- [POST /automation/{id}/disable](/docs/api-reference/workflows/automation/disableautomation) — Disable a workflow
- [POST /automation/{id}/transfer](/docs/api-reference/workflows/automation/transferautomation) — Transfer ownership of a workflow
- [POST /automation/{id}/share](/docs/api-reference/workflows/automation/shareautomation) — Share a workflow
- [GET /automation/{id}/share](/docs/api-reference/workflows/automation/listautomationshares) — List a workflow’s shares
- [DELETE /automation/{id}/share/{aclId}](/docs/api-reference/workflows/automation/revokeautomationshare) — Revoke a workflow share
- [POST /automation/{id}/run](/docs/api-reference/workflows/automation/runautomation) — Run a workflow manually
- [GET /automation/{id}/run](/docs/api-reference/workflows/automation/listautomationruns) — List a workflow’s runs
- [POST /automation/{id}/dry-run](/docs/api-reference/workflows/automation/dryrunautomation) — Dry-run a workflow
- [GET /automation/{id}/run/{runId}](/docs/api-reference/workflows/automation/getautomationrun) — Get one run
- [GET /automation/{id}/run/{runId}/step](/docs/api-reference/workflows/automation/listautomationrunsteps) — List a run’s steps
- [GET /automation/{id}/run/{runId}/progress](/docs/api-reference/workflows/automation/getautomationrunprogress) — Where a run is, step by step
- [GET /automation/{id}/run/{runId}/step/{seq}](/docs/api-reference/workflows/automation/getautomationrunstep) — Get one run step, with its full output
- [POST /automation/{id}/run/{runId}/retry](/docs/api-reference/workflows/automation/retryautomationrun) — Retry a failed run
- [POST /automation/{id}/run/{runId}/cancel](/docs/api-reference/workflows/automation/cancelautomationrun) — Cancel an active run
- [GET /automation/{id}/state](/docs/api-reference/workflows/automation/listautomationstate) — List a workflow’s persisted state entries
- [GET /automation/{id}/webhook](/docs/api-reference/workflows/automation/listautomationwebhooks) — List a workflow’s webhook endpoints
- [POST /automation/{id}/webhook/{triggerKey}/reveal](/docs/api-reference/workflows/automation/revealautomationwebhooksecret) — Reveal a webhook secret once
- [POST /automation/{id}/webhook/{triggerKey}/rotate](/docs/api-reference/workflows/automation/rotateautomationwebhooksecret) — Rotate a webhook secret
- [PUT /automation/{id}/webhook/{triggerKey}/secret](/docs/api-reference/workflows/automation/setautomationwebhooksecret) — Set an hmac webhook secret
- [GET /automation/{id}/webhook/{triggerKey}/sample](/docs/api-reference/workflows/automation/listautomationwebhooksamples) — List captured webhook samples
- [GET /automation/{id}/webhook/{triggerKey}/sample/{sampleId}](/docs/api-reference/workflows/automation/getautomationwebhooksample) — Get one captured webhook sample, with its payload
- [DELETE /automation/{id}/webhook/{triggerKey}/sample/{sampleId}](/docs/api-reference/workflows/automation/deleteautomationwebhooksample) — Delete one captured webhook sample
- [GET /automation/{id}/approval](/docs/api-reference/workflows/automation/listautomationapprovals) — List one workflow’s approvals
- [GET /automation/{id}/session](/docs/api-reference/workflows/automation/listautomationsessions) — List the runbook sessions of a workflow
- [GET /automation/{id}/session/{sessionId}](/docs/api-reference/workflows/automation/getautomationsession) — Get one runbook session
- [GET /automation/{id}/session/{sessionId}/run](/docs/api-reference/workflows/automation/listautomationsessionruns) — List the runs of a session
- [POST /automation/{id}/session/{sessionId}/run](/docs/api-reference/workflows/automation/continueautomationsession) — Start another run in a session
- [GET /automation/{id}/session/{sessionId}/participant](/docs/api-reference/workflows/automation/listautomationsessionparticipants) — List the people who started runs in a session
- [GET /automation/{id}/session/{sessionId}/artifact](/docs/api-reference/workflows/automation/listautomationsessionartifacts) — List the collection rows a session produced
- [GET /automation/{id}/session/{sessionId}/message](/docs/api-reference/workflows/automation/listautomationsessionmessages) — Preview the agent transcript of a session
- [POST /automation/{id}/session/{sessionId}/close](/docs/api-reference/workflows/automation/closeautomationsession) — Close a session
- [GET /automation/{id}/usage](/docs/api-reference/workflows/automation/getautomationusage) — A workflow’s usage against its limits
- [GET /automation/{id}/run/{runId}/step/{seq}/transcript](/docs/api-reference/workflows/automation/listautomationagentsteptranscript) — Read an agent step transcript
- [GET /automation/models](/docs/api-reference/workflows/automation/listautomationmodels) — List the AI models an agent step can use
- [GET /automation/{id}/config](/docs/api-reference/workflows/automation/getautomationconfig) — Get a workflow config
- [PUT /automation/{id}/config](/docs/api-reference/workflows/automation/updateautomationconfig) — Update a workflow config (compare-and-swap)
- [POST /automation/{id}/options](/docs/api-reference/workflows/automation/listautomationoptions) — List the options for an input or config field
- [GET /automation/{id}/run/{runId}/warning](/docs/api-reference/workflows/automation/listautomationrunwarnings) — List the warnings of a run