Automation

Get a workflow

Read workflow details and draft source.

Read workflow details and draft source. The ETag is the draft revision to use in If-Match for updates.

GET /automation/v1/workflows/{ns}/{name}

Authentication

Authorization: Bearer $PRAXIS_API_KEY

Request fields

ParameterTypeDescription
path: nsstringrequired; Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63}. praxis is read-only.
path: namestringrequired; Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63}.

Examples

Set these environment variables to your own resources:

VariableSource
WORKFLOW_NAMEname returned by creating a workflow
: "${WORKFLOW_NAME:?Set WORKFLOW_NAME}"
curl --fail-with-body -X GET "https://api.deepraxis.ai/automation/v1/workflows/docs-samples/${WORKFLOW_NAME}" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"
import { createAutomationClient } from '@deepraxis/sdk/automation';

function env(name: string): string {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
}
const automation = createAutomationClient({
  apiKey: env('PRAXIS_API_KEY'),
  baseUrl: 'https://api.deepraxis.ai',
  maxRetries: 0,
  timeoutMs: 90_000,
});
const result = await automation.workflows.retrieve({
  "path": {
    "ns": "docs-samples",
    "name": env("WORKFLOW_NAME")
  }
});
console.log(result);

Response

HTTP 200

Success

HeaderTypeDescription
ETagstringCurrent resource revision for conditional updates.

application/json

FieldTypeDescription
draftobjectrequired; The editable draft of a script or workflow; publishing takes the draft or a run's source. no additional fields.
draft.sourcestringrequired; Draft source: TypeScript for scripts, YAML for workflows.
draft.revisionstringrequired; Draft revision tag (ETag); send it as expected_draft_revision when publishing or as If-Match when updating the draft; a mismatch returns 412.
draft.updated_atstringrequired; Time the draft was last changed (RFC 3339 UTC).
draft.updated_byobjectrequired; Principal {type, id} injected by the gateway that says who initiated or acted. This service does not resolve names; the console resolves them in batches. no additional fields.
draft.updated_by.type"user" / "api_key" / "agent" / "run" / "trigger"required; Principal type. user is a signed-in user; api_key is a platform API key; agent is an agent; run is an action performed by a run itself (for example a parent run); trigger is a trigger.
draft.updated_by.idstringrequired; Principal identifier whose meaning follows type: a user, API key, agent, run or trigger id. Treat it as an opaque string.
idstringrequired; Definition id, prefixed scr_ for scripts and wf_ for workflows; calls normally use namespace and name.
kind"script" / "workflow"required; Orchestration kind. script is a TypeScript script that executes once; workflow is a YAML workflow made of steps that can wait for events, timers or child runs and can be suspended.
namespacestringrequired; Namespace; references take the form namespace/name@version.
namestringrequired; Name; with namespace it is unique within the tenant, and scripts and workflows share one namespace (duplicates return 409 NAME_TAKEN).
descriptionstringrequired; Free-text description, at most 1000 characters.
labelsobjectrequired; User-defined string key and value tags for grouping and list filtering (labels[key]=value); keys must not start with praxis.
ownerstringrequired; Tenant that owns the definition, injected by the gateway; treat it as an opaque string.
latest_versionnull / objectrequired; The published version the latest tag points to, as {version, published_at}; null if nothing is published.
latest_version (variant 2).versionstringrequired; Version number (semver) of the latest published version.
latest_version (variant 2).published_atstringrequired; Time that version was published (RFC 3339 UTC).
dist_tagsobjectrequired; Map from dist-tag to the exact version it points to, for example latest to 1.2.0; ns/name@tag resolves through it.
draft_changedbooleanrequired; true when the draft content (digest) differs from the latest version, meaning there are unpublished changes.
latest_runnull / objectrequired; Summary of the most recent run of this definition, or null if it has never run.
latest_run (variant 2).idstringrequired; Run id (run_ prefix); pass it to runs.retrieve.
latest_run (variant 2).numbernull / numberrequired; Increasing sequence number of the run within its script or workflow.
latest_run (variant 2).status"running" / "completed" / "faulted" / "cancelled" / "pending" / "waiting" / "suspended"required; Run status. pending is created but not started; running is executing; waiting means a workflow is waiting on an event, timer or child run; suspended means a workflow was suspended; cancelled was cancelled; faulted failed; completed finished successfully.
latest_run (variant 2).created_atstringrequired; Time the run was created (RFC 3339 UTC).
latest_run (variant 2).current_waitnull / objectrequired; The wait point currently open, or null when the run is not waiting.
latest_run (variant 2).current_wait (variant 2).idstringrequired; Wait point id, prefixed wait_; use it as wait_id when completing an event wait.
latest_run (variant 2).current_wait (variant 2).run_idstringrequired; Id (run_) of the run this wait belongs to.
latest_run (variant 2).current_wait (variant 2).kind"event" / "timer" / "child"required; Wait kind. event waits for an external event that can be submitted with runs.completeWait; timer waits until resume_at; child waits for a child run to finish.
latest_run (variant 2).current_wait (variant 2).state"cancelled" / "open" / "resolved" / "expired"required; Wait point state. open is still waiting; resolved was satisfied; expired passed its expires_at; cancelled was cancelled and can no longer be satisfied.
latest_run (variant 2).current_wait (variant 2).tasknull / objectrequired; The workflow step {reference, name} that produced the wait; null when there is no such step.
latest_run (variant 2).current_wait (variant 2).task (variant 2).referencestringrequired; JSON Pointer of the step, for example /do/2/wait_payment.
latest_run (variant 2).current_wait (variant 2).task (variant 2).namestringrequired; Step name, the key in the workflow YAML.
latest_run (variant 2).current_wait (variant 2).resume_atnull / stringrequired; For kind=timer, the instant the run resumes (RFC 3339 UTC); null for other kinds.
latest_run (variant 2).current_wait (variant 2).event_typenull / stringrequired; For kind=event, the event type being awaited; null for other kinds.
latest_run (variant 2).current_wait (variant 2).child_run_idnull / stringrequired; For kind=child, the id of the child run being awaited; null for other kinds.
latest_run (variant 2).current_wait (variant 2).created_atstringrequired; Time the wait point was created (RFC 3339 UTC).
latest_run (variant 2).current_wait (variant 2).expires_atnull / stringrequired; Time the wait point expires (RFC 3339 UTC), or null if it has no deadline.
latest_run (variant 2).current_wait (variant 2).resolved_atnull / stringrequired; Time the wait point was resolved (RFC 3339 UTC), or null if still open.
stats_7dobjectrequired; Run statistics for the last seven days, bucketed by the day each run ended and updated when runs finish. no additional fields.
stats_7d.runsnumberrequired; Number of runs that ended in the last seven days, in any terminal status.
stats_7d.failuresnumberrequired; How many of those runs ended faulted.
archived_atnull / stringrequired; Archive time, or null while not archived. An archived name stays reserved and cannot be reused.
created_atstringrequired; Creation time (RFC 3339 UTC).
updated_atstringrequired; Time of the last update (RFC 3339 UTC).

Measured response

HTTP 200

{
  "id": "wf_00mv67m4jad0d5c2a3d1e04dc9ac4c18cff616eca7",
  "owner": "tnt_3a9759864ccb4e00",
  "kind": "workflow",
  "namespace": "docs-samples",
  "name": "sample-workflows-1791867412840-b05e8a",
  "description": "",
  "labels": {},
  "latest_version": null,
  "dist_tags": {},
  "draft_changed": true,
  "latest_run": null,
  "stats_7d": {
    "runs": 0,
    "failures": 0
  },
  "archived_at": null,
  "created_at": "2026-10-13T04:57:29.206Z",
  "updated_at": "2026-10-13T04:57:29.206Z",
  "draft": {
    "source": "document:\n  dsl: '1.0.3'\n  namespace: docs-samples\n  name: sample-workflows-1791867412840-b05e8a\n  version: '1.0.0'\ndo:\n  - answer:\n      set:\n        answer: 42\n",
    "revision": "draft_00mv67m4ja0e38625d463646e3a526bb774bf453ee",
    "updated_at": "2026-10-13T04:57:29.206Z",
    "updated_by": {
      "type": "api_key",
      "id": "key_3e00b8984967"
    }
  }
}

Errors

HTTPCodes and description
400INVALID_PARAMS: Invalid request parameters, path, cursor, or body format.
404TARGET_NOT_FOUND: The target does not exist or has an incompatible type.
defaultRFC 9457 automation problem. 429 includes Retry-After.

Authentication and common errors · Retain the X-Request-Id response header for troubleshooting.

Export

On this page