All operations

Contract

The three routes that need no token: where to authenticate, the machine contract itself, and a redirect to the human guide. Read them before obtaining a credential.

GET/.well-known/oauth-protected-resourceProtected-resource metadata for the automation API GET/v1/openapi.jsonThe machine contract for this API, generated from the live route schemas GET/v1/docsRedirect to the human integration guide

Identity

What the presented credential is and what it may do. The first call to make with a fresh token, and the first call to repeat when one is refused.

GET/v1/whoamiThe calling credential's identity, workspace, effective and granted scopes

Discovery

The workspace's apps and their inbound and outbound ports. A dataset node's declared column schema is the contract a file has to satisfy.

GET/v1/appsList the workspace's apps GET/v1/apps/{app}One app with its inbound and outbound port counts GET/v1/apps/{app}/datasetsThe app's dataset nodes and their declared column schemas GET/v1/apps/{app}/outputsThe app's output nodes from its latest successful published run

Imports

The staged CSV import loop: stage, upload, commit, poll. Validation is all or nothing and a commit is safe to retry.

POST/v1/apps/{app}/datasets/{node}/importsStage a CSV import and mint its upload URL POST/v1/apps/{app}/datasets/{node}/imports/{id}/commitValidate and apply the staged CSV (asynchronous; poll the import for the outcome)GET/v1/apps/{app}/datasets/{node}/imports/{id}One staged import's status and outcome, with a fresh upload URL while staging GET/v1/apps/{app}/datasets/{node}/imports/{id}/errorsA short-lived download URL for the failed import's full error report

Runs

Pipeline execution: trigger a run against the published or the draft configuration, then poll it. One run per app at a time.

POST/v1/apps/{app}/runsRun the app's pipeline (asynchronous; poll the run for the outcome)GET/v1/apps/{app}/runsThe app's run history, newest first GET/v1/apps/{app}/runs/{runId}One run's status, per-node outcomes and failure summary

Exports

Generated CSV of an output node's result: request, poll, download. Pin a run identifier to make a load reproducible.

POST/v1/apps/{app}/outputs/{node}/exportsGenerate an output node's result as CSV (asynchronous; poll the export)GET/v1/apps/{app}/exports/{exportId}One export's status and a short-lived download URL once it is ready