# Automation API (/en/docs/api/native/automation)



Praxis Automation runs TypeScript scripts and YAML workflows with reusable Actions, triggers and inspectable run results. This is a Praxis-native API. Differences: choose your own namespace without registration, while praxis is read-only; Actions use ns/name at their current revision, while published scripts and workflows use ns/name\@version or @tag; drafts can run directly as source without publishing; schedule and webhook triggers require a published target. Start with `praxis.automation.runs.create` to test source or execute a published target.



Manage actions, publish scripts and workflows, inspect runs, and receive inbound webhooks.

`https://api.deepraxis.ai/automation/v1`

## Authentication [#authentication]

Use `Authorization: Bearer $PRAXIS_API_KEY`. Inbound webhooks use the secret URL returned on creation or rotation, without an API Key.

## TypeScript SDK [#typescript-sdk]

The SDK is not published to npm. Install from local source and run examples with Bun; replace the path with your local SDK directory.

```bash
bun add /absolute/path/to/packages/sdk/typescript
bun example.ts
```

Examples target develop. Install jq for curl bodies containing variables. Choose unused names beginning with `sample-`. Actions, scripts and workflows use the `docs-samples` namespace; archive them after use and delete triggers.

## Actions [#actions]

- [List actions](/en/docs/api/native/automation/listActions)
- [Create an action](/en/docs/api/native/automation/createAction)
- [Get an action](/en/docs/api/native/automation/getAction)
- [Update an action](/en/docs/api/native/automation/updateAction)
- [List action revisions](/en/docs/api/native/automation/listActionRevisions)
- [Get an action revision](/en/docs/api/native/automation/getActionRevision)
- [Roll back an action](/en/docs/api/native/automation/rollbackAction)
- [List action invocations](/en/docs/api/native/automation/listActionInvocations)
- [List action dependents](/en/docs/api/native/automation/listActionDependents)
- [Archive an action](/en/docs/api/native/automation/archiveAction)
- [Restore an action](/en/docs/api/native/automation/restoreAction)

## Scripts [#scripts]

- [List scripts](/en/docs/api/native/automation/listScripts)
- [Create a script](/en/docs/api/native/automation/createScript)
- [Get a script](/en/docs/api/native/automation/getScript)
- [Update a script draft](/en/docs/api/native/automation/updateScript)
- [Archive a script](/en/docs/api/native/automation/archiveScript)
- [Restore a script](/en/docs/api/native/automation/restoreScript)
- [Publish a script version](/en/docs/api/native/automation/publishScriptVersion)
- [List script versions](/en/docs/api/native/automation/listScriptVersions)
- [Get a script version](/en/docs/api/native/automation/getScriptVersion)
- [Deprecate a script version](/en/docs/api/native/automation/deprecateScriptVersion)
- [List script tags](/en/docs/api/native/automation/listScriptTags)
- [Set a script tag](/en/docs/api/native/automation/setScriptTag)
- [Delete a script tag](/en/docs/api/native/automation/deleteScriptTag)

## Workflows [#workflows]

- [List workflows](/en/docs/api/native/automation/listWorkflows)
- [Create a workflow](/en/docs/api/native/automation/createWorkflow)
- [Get a workflow](/en/docs/api/native/automation/getWorkflow)
- [Update a workflow draft](/en/docs/api/native/automation/updateWorkflow)
- [Archive a workflow](/en/docs/api/native/automation/archiveWorkflow)
- [Restore a workflow](/en/docs/api/native/automation/restoreWorkflow)
- [Publish a workflow version](/en/docs/api/native/automation/publishWorkflowVersion)
- [List workflow versions](/en/docs/api/native/automation/listWorkflowVersions)
- [Get a workflow version](/en/docs/api/native/automation/getWorkflowVersion)
- [Deprecate a workflow version](/en/docs/api/native/automation/deprecateWorkflowVersion)
- [List workflow tags](/en/docs/api/native/automation/listWorkflowTags)
- [Set a workflow tag](/en/docs/api/native/automation/setWorkflowTag)
- [Delete a workflow tag](/en/docs/api/native/automation/deleteWorkflowTag)

## Definition tools [#definition-tools]

- [Validate a definition](/en/docs/api/native/automation/validateDefinition)
- [Resolve a run target](/en/docs/api/native/automation/resolveTarget)
- [Search automation definitions](/en/docs/api/native/automation/searchTargets)

## Runs [#runs]

- [Create a run](/en/docs/api/native/automation/createRun)
- [List runs](/en/docs/api/native/automation/listRuns)
- [Get a run](/en/docs/api/native/automation/getRun)
- [Cancel a run](/en/docs/api/native/automation/cancelRun)
- [Rerun a run](/en/docs/api/native/automation/rerunRun)
- [Suspend a run](/en/docs/api/native/automation/suspendRun)
- [Resume a run](/en/docs/api/native/automation/resumeRun)
- [List run waits](/en/docs/api/native/automation/listRunWaits)
- [List run calls](/en/docs/api/native/automation/listRunCalls)
- [List run artifacts](/en/docs/api/native/automation/listRunArtifacts)
- [Complete a run wait](/en/docs/api/native/automation/completeRunWait)
- [List run tasks](/en/docs/api/native/automation/listRunTasks)
- [Read run events](/en/docs/api/native/automation/listRunEvents)
- [Read run logs](/en/docs/api/native/automation/listRunLogs)
- [Get run source](/en/docs/api/native/automation/getRunSource)

## Triggers and inbound webhooks [#triggers-and-inbound-webhooks]

- [List triggers](/en/docs/api/native/automation/listTriggers)
- [Create a trigger](/en/docs/api/native/automation/createTrigger)
- [Get a trigger](/en/docs/api/native/automation/getTrigger)
- [Update a trigger](/en/docs/api/native/automation/updateTrigger)
- [Delete a trigger](/en/docs/api/native/automation/deleteTrigger)
- [Pause a trigger](/en/docs/api/native/automation/pauseTrigger)
- [Resume a trigger](/en/docs/api/native/automation/resumeTrigger)
- [Fire a trigger now](/en/docs/api/native/automation/fireTrigger)
- [Rotate a webhook URL](/en/docs/api/native/automation/rotateTriggerWebhook)
- [List trigger firings](/en/docs/api/native/automation/listTriggerFirings)
- [Preview a trigger schedule](/en/docs/api/native/automation/previewTriggerSchedule)
- [Receive a webhook](/en/docs/api/native/automation/receiveWebhook)
