# All operations (/docs/de/integrations/api/reference/overview)



{/* Generated by scripts/generate-api-reference.mts from the published contract. Do not edit; regenerate instead. */}

## Contract [#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.

<OperationList>
  <OperationLink method="GET" path="/.well-known/oauth-protected-resource" href="./get-protected-resource-metadata.mdx">
    Protected-resource metadata for the automation API
  </OperationLink>

  <OperationLink method="GET" path="/v1/openapi.json" href="./get-open-api-document.mdx">
    The machine contract for this API, generated from the live route schemas
  </OperationLink>

  <OperationLink method="GET" path="/v1/docs" href="./get-docs-redirect.mdx">
    Redirect to the human integration guide
  </OperationLink>
</OperationList>

## Identity [#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.

<OperationList>
  <OperationLink method="GET" path="/v1/whoami" href="./get-whoami.mdx">
    The calling credential's identity, workspace, effective and granted scopes
  </OperationLink>
</OperationList>

## Discovery [#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.

<OperationList>
  <OperationLink method="GET" path="/v1/apps" href="./list-apps.mdx">
    List the workspace's apps
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}" href="./get-app.mdx">
    One app with its inbound and outbound port counts
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/datasets" href="./list-datasets.mdx">
    The app's dataset nodes and their declared column schemas
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/outputs" href="./list-outputs.mdx">
    The app's output nodes from its latest successful published run
  </OperationLink>
</OperationList>

## Imports [#imports]

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

<OperationList>
  <OperationLink method="POST" path="/v1/apps/{app}/datasets/{node}/imports" href="./create-import.mdx">
    Stage a CSV import and mint its upload URL
  </OperationLink>

  <OperationLink method="POST" path="/v1/apps/{app}/datasets/{node}/imports/{id}/commit" href="./commit-import.mdx">
    Validate and apply the staged CSV (asynchronous; poll the import for the outcome)
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/datasets/{node}/imports/{id}" href="./get-import.mdx">
    One staged import's status and outcome, with a fresh upload URL while staging
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/datasets/{node}/imports/{id}/errors" href="./get-import-errors.mdx">
    A short-lived download URL for the failed import's full error report
  </OperationLink>
</OperationList>

## Runs [#runs]

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

<OperationList>
  <OperationLink method="POST" path="/v1/apps/{app}/runs" href="./start-run.mdx">
    Run the app's pipeline (asynchronous; poll the run for the outcome)
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/runs" href="./list-runs.mdx">
    The app's run history, newest first
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/runs/{runId}" href="./get-run.mdx">
    One run's status, per-node outcomes and failure summary
  </OperationLink>
</OperationList>

## Exports [#exports]

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

<OperationList>
  <OperationLink method="POST" path="/v1/apps/{app}/outputs/{node}/exports" href="./create-export.mdx">
    Generate an output node's result as CSV (asynchronous; poll the export)
  </OperationLink>

  <OperationLink method="GET" path="/v1/apps/{app}/exports/{exportId}" href="./get-export.mdx">
    One export's status and a short-lived download URL once it is ready
  </OperationLink>
</OperationList>