Automation

List scripts

List visible script summaries, latest versions, tags and seven-day statistics.

List visible script summaries, latest versions, tags and seven-day statistics. Archived entries are excluded by default.

GET /automation/v1/scripts

Authentication

Authorization: Bearer $PRAXIS_API_KEY

Request fields

ParameterTypeDescription
query: limitintegeroptional; Page size: integer 1–100, default 25. minimum: 1; maximum: 100
query: cursorstringoptional; Opaque next_cursor from the previous page; keep the original filters when paging.
query: qstringoptional; Case-insensitive literal substring of name or description; % and _ are not wildcards.
query: namespacestring[]optional; Return definitions in this namespace, matched in lowercase. Separate multiple values with commas to match any value. minItems: 1
query: scope"platform" / "own"[]optional; platform selects platform definitions, own tenant-created definitions; omit for both. Separate multiple values with commas to match any value. minItems: 1
query: archivedbooleanoptional; true selects archived entries only, false unarchived only; default false.
query: labelsobjectoptional; Filter using labels[k]=v; comma-separated values for one key match any, and different keys match together.
query: created_at[gte]stringoptional; Inclusive creation-time lower bound, as an ISO 8601 timestamp with timezone. format: "date-time"
query: created_at[lte]stringoptional; Inclusive creation-time upper bound, as an ISO 8601 timestamp with timezone. format: "date-time"

Examples

curl --fail-with-body -X GET "https://api.deepraxis.ai/automation/v1/scripts" \
  -H "Authorization: Bearer $PRAXIS_API_KEY" \
  --get \
  --data-urlencode "namespace=docs-samples" \
  --data-urlencode "limit=1"
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.scripts.list({
  "query": {
    "namespace": [
      "docs-samples"
    ],
    "limit": 1
  }
});
console.log(result);

Response

HTTP 200

Success

application/json

FieldTypeDescription
dataobject[]required; Script summaries on this page, ordered by created_at descending, then id descending.
data[].idstringrequired; Definition id, prefixed scr_ for scripts and wf_ for workflows; calls normally use namespace and name.
data[].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.
data[].namespacestringrequired; Namespace; references take the form namespace/name@version.
data[].namestringrequired; Name; with namespace it is unique within the tenant, and scripts and workflows share one namespace (duplicates return 409 NAME_TAKEN).
data[].descriptionstringrequired; Free-text description, at most 1000 characters.
data[].labelsobjectrequired; User-defined string key and value tags for grouping and list filtering (labels[key]=value); keys must not start with praxis.
data[].ownerstringrequired; Tenant that owns the definition, injected by the gateway; treat it as an opaque string.
data[].latest_versionnull / objectrequired; The published version the latest tag points to, as {version, published_at}; null if nothing is published.
data[].latest_version (variant 2).versionstringrequired; Version number (semver) of the latest published version.
data[].latest_version (variant 2).published_atstringrequired; Time that version was published (RFC 3339 UTC).
data[].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.
data[].draft_changedbooleanrequired; true when the draft content (digest) differs from the latest version, meaning there are unpublished changes.
data[].latest_runnull / objectrequired; Summary of the most recent run of this definition, or null if it has never run.
data[].latest_run (variant 2).idstringrequired; Run id (run_ prefix); pass it to runs.retrieve.
data[].latest_run (variant 2).numbernull / numberrequired; Increasing sequence number of the run within its script or workflow.
data[].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.
data[].latest_run (variant 2).created_atstringrequired; Time the run was created (RFC 3339 UTC).
data[].latest_run (variant 2).current_waitnull / objectrequired; The wait point currently open, or null when the run is not waiting.
data[].latest_run (variant 2).current_wait (variant 2).idstringrequired; Wait point id, prefixed wait_; use it as wait_id when completing an event wait.
data[].latest_run (variant 2).current_wait (variant 2).run_idstringrequired; Id (run_) of the run this wait belongs to.
data[].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.
data[].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.
data[].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.
data[].latest_run (variant 2).current_wait (variant 2).task (variant 2).referencestringrequired; JSON Pointer of the step, for example /do/2/wait_payment.
data[].latest_run (variant 2).current_wait (variant 2).task (variant 2).namestringrequired; Step name, the key in the workflow YAML.
data[].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.
data[].latest_run (variant 2).current_wait (variant 2).event_typenull / stringrequired; For kind=event, the event type being awaited; null for other kinds.
data[].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.
data[].latest_run (variant 2).current_wait (variant 2).created_atstringrequired; Time the wait point was created (RFC 3339 UTC).
data[].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.
data[].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.
data[].stats_7dobjectrequired; Run statistics for the last seven days, bucketed by the day each run ended and updated when runs finish. no additional fields.
data[].stats_7d.runsnumberrequired; Number of runs that ended in the last seven days, in any terminal status.
data[].stats_7d.failuresnumberrequired; How many of those runs ended faulted.
data[].archived_atnull / stringrequired; Archive time, or null while not archived. An archived name stays reserved and cannot be reused.
data[].created_atstringrequired; Creation time (RFC 3339 UTC).
data[].updated_atstringrequired; Time of the last update (RFC 3339 UTC).
next_cursornull / stringrequired; Cursor for the next page: pass it unchanged as cursor with the same filters; null when there are no more pages. No total is returned.

Measured response

HTTP 200

{
  "data": [
    {
      "id": "scr_00mv67lwvh08624c70ef824a0d8b14b0315c88452e",
      "owner": "tnt_3a9759864ccb4e00",
      "kind": "script",
      "namespace": "docs-samples",
      "name": "sample-scripts-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:19.277Z",
      "updated_at": "2026-10-13T04:57:19.277Z"
    }
  ],
  "next_cursor": null
}

Errors

HTTPCodes and description
400INVALID_PARAMS: Invalid request parameters, path, cursor, or body format.
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