> ## Documentation Index
> Fetch the complete documentation index at: https://docs.langdock.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflow API Übersicht

> Liste, erstelle, aktualisiere, veröffentliche und lösche Workflows und lies paginierte Ausführungsdaten über die Public API

Mit der Workflow API verwaltest du Workflow-Definitionen und liest paginierte Ausführungsdaten. Nutze sie, um Workflows aus einem Repository zu synchronisieren, einen Entwurf zu veröffentlichen oder Node-Eingaben und -Ausgaben zu prüfen. Der flache Ausführungs-Export bleibt ein eigener Endpoint.

## Basis-URL

```
https://api.langdock.com
```

<Warning>
  **Dedicated Deployments**

  Ersetze `api.langdock.com` durch `<your-deployment-url>/api/public` in allen Anfragen.
</Warning>

## API-Key-Scopes

Der Workflow-Zugriff ist in drei Scopes aufgeteilt. Ein Key kann jede Kombination davon haben.

| Scope                 | Label in den Einstellungen | Endpoints                                                                                                                                                                                                                                                   |
| --------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `WORKFLOW_API`        | **Workflow-Lese-API**      | [Auflisten](/de/developer/workflow-api/list-workflows), [Abrufen](/de/developer/workflow-api/get-workflow), [paginierte Ausführungen](/de/developer/workflow-api/list-workflow-runs) und [flacher Export](/de/developer/workflow-api/intro-to-workflow-api) |
| `WORKFLOW_WRITE_API`  | **Workflow-Schreib-API**   | [Erstellen](/de/developer/workflow-api/create-workflow), [Aktualisieren](/de/developer/workflow-api/update-workflow), [Veröffentlichen](/de/developer/workflow-api/publish-workflow)                                                                        |
| `WORKFLOW_DELETE_API` | **Workflow-Lösch-API**     | [Löschen](/de/developer/workflow-api/delete-workflow)                                                                                                                                                                                                       |

Erstelle einen Workspace-API-Key unter [Einstellungen > Workspace > Produkte > API](/de/admin/workspace/workspace#api). Ein persönlicher API-Key kann die **Workflow-Lese-API** enthalten, und die **Workflow-Schreib-API**, wenn dein Admin sie erlaubt. Die **Workflow-Lösch-API** kannst du einem persönlichen Key nicht geben. Mehr dazu findest du unter [Persönliche API-Keys](/de/using-langdock/account/personal-api-keys).

Die API läuft als der User, den der Key konfiguriert. Workspace-Keys laufen als Service-Account. Persönliche Keys laufen als ihr Besitzer.

## Verfügbare Endpoints

| Methode  | Endpoint                       | Beschreibung                                                                     |
| -------- | ------------------------------ | -------------------------------------------------------------------------------- |
| `GET`    | `/workflows/v1/list`           | [Workflows auflisten](/de/developer/workflow-api/list-workflows)                 |
| `POST`   | `/workflows/v1/create`         | [Workflow erstellen](/de/developer/workflow-api/create-workflow)                 |
| `GET`    | `/workflows/v1/get`            | [Workflow abrufen](/de/developer/workflow-api/get-workflow)                      |
| `PATCH`  | `/workflows/v1/update`         | [Workflow aktualisieren](/de/developer/workflow-api/update-workflow)             |
| `POST`   | `/workflows/v1/publish`        | [Workflow veröffentlichen](/de/developer/workflow-api/publish-workflow)          |
| `DELETE` | `/workflows/v1/delete`         | [Workflow löschen](/de/developer/workflow-api/delete-workflow)                   |
| `GET`    | `/workflows/v1/runs`           | [Workflow-Ausführungen auflisten](/de/developer/workflow-api/list-workflow-runs) |
| `GET`    | `/workflows/{workflowId}/runs` | [Flachen Export abrufen](/de/developer/workflow-api/intro-to-workflow-api)       |

Paginierte Ausführungen (`/workflows/v1/runs`) liefern Run-Objekte mit Node-Ausführungen, Filter wie `runMode` und einen Cursor. Der flache Export (`/workflows/{workflowId}/runs`) liefert zeilenweise Daten in einem Datumsbereich, paginiert nicht und ist auf 10.000 Ausführungen begrenzt.

## Workflow-Objekt

Abrufen, Erstellen, Aktualisieren und Veröffentlichen geben dasselbe Workflow-Objekt zurück:

```typescript theme={null}
{
  id: string;
  name: string;
  description: string | null;
  status: "ACTIVE" | "INACTIVE";
  timezone: string | null;
  createdAt: string;
  updatedAt: string;
  createdBy: string;
  owner: { id: string; name: string | null };
  versionId: string;
  version: string;
  nodes: Array<object>;
  edges: Array<object>;
  versions: Array<{
    id: string;
    version: string;
    description: string;
    createdAt: string;
  }>;
  activeVersion: {
    id: string;
    version: string;
    description: string;
    createdAt: string;
    updatedAt: string;
    createdBy: string;
    nodes: Array<object>;
    edges: Array<object>;
  } | null;
  hasPublishedVersion: boolean;
  limits: {
    monthlyCostUsd: number | null;
    perRunCostUsd: number | null;
    maxExecutionsPerHour: number | null;
  };
}
```

`nodes` und `edges` sind der Entwurf (Version `0`). `activeVersion` ist der veröffentlichte Graph, wenn einer existiert. Geheimnisähnliche Felder wie Webhook-Secrets werden redigiert. Wenn du einen redigierten Graphen in einem Update zurückschickst, bleiben die gespeicherten Secrets erhalten.

## Berechtigungen

| Aktion                             | Erforderlicher Zugriff                                                                                                                                                 |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Auflisten oder abrufen             | Betrachterzugriff. Workspace-Admin-Identitäten, inklusive Workspace-API-Keys, sehen jeden Workflow, der keine Vorlage ist.                                             |
| Paginierte Ausführungen            | Bearbeiterzugriff                                                                                                                                                      |
| Flacher Export                     | Besitzer oder Bearbeiter. Die Rolle **Nutzer** gewährt diesen Export nicht. Siehe [Workflow-Ausführungs-Export-API](/de/developer/workflow-api/intro-to-workflow-api). |
| Erstellen                          | Berechtigung `createWorkflows`                                                                                                                                         |
| Aktualisieren oder veröffentlichen | Bearbeiterzugriff                                                                                                                                                      |
| Löschen                            | Bearbeiterzugriff und `WORKFLOW_DELETE_API`. Im Builder brauchst du weiterhin Besitz.                                                                                  |
| `shareWith` beim Erstellen         | Berechtigung `shareWorkflows`                                                                                                                                          |

Neu erstellte Workflows bleiben privat für den Key, bis du `shareWith` setzt oder jemand sie später teilt. Workspace-Admins können einen Workflow über **Teilen** mit einem aktiven Workspace-API-Key teilen. Nutze **Personen, Gruppen und API-Keys suchen**, um den Key zu finden. Persönliche Keys sind keine Freigabeziele, weil sie bereits als ihr Besitzer auftreten.

Vorlagen kannst du über diese API nicht erstellen, auflisten oder veröffentlichen.

## Rate Limits

Die Workflow API folgt den Standard-API-Rate-Limits. Wenn du das Limit überschreitest, erhältst du eine `429`-Antwort. Warte und versuche es mit exponentiellem Backoff erneut.

<Info>
  Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu [Best Practices für API-Schlüssel](/de/admin/ai-adoption-and-rollout/best-practices/api-key-best-practices).
</Info>
