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

# Octoparse OpenAPI

> Octoparse-OpenAPI-Referenz für Authentifizierung, Aufgabenverwaltung, Cloud-Extraktion und Datenexport.

Verwenden Sie die Octoparse OpenAPI, um Aufgaben zu verwalten, Cloud-Extraktionen auszuführen und gescrapte Daten programmgesteuert abzurufen.

## Authentifizierung

Für geschützte Endpunkte ist ein Octoparse-API-Schlüssel die einfachste Authentifizierungsmethode. Erstellen Sie im Octoparse-Kontocenter einen Schlüssel und fügen Sie ihn in den Anfrage-Header `x-api-key` ein. Derselbe API-Schlüssel kann mit Octoparse OpenAPI, MCP Server und CLI verwendet werden.

<Card title="API-Schlüssel erstellen oder verwalten" icon="key" href="https://www.octoparse.de/console/account-center/api-keys">
  Öffnen Sie die Seite für API-Schlüssel in Ihrem Octoparse-Kontocenter.
</Card>

API-Schlüssel beginnen üblicherweise mit `op_sk_`:

```bash theme={null}
curl "https://openapi.octoparse.com/taskGroup" \
  --header "x-api-key: op_sk_xxxxx"
```

<Warning>
  Halten Sie Ihren API-Schlüssel geheim. Legen Sie ihn nicht in browserseitigem Code, öffentlichen Repositorys, Screenshots oder Protokollen offen.
</Warning>

Die Authentifizierung mit Zugriffstoken wird ebenfalls unterstützt. Rufen Sie über `POST /token` ein Zugriffstoken ab und senden Sie es als `Authorization: Bearer <access_token>`.

## AgentTools API

Die AgentTools API ist eine vorlagengesteuerte Workflow-Ebene für KI-Agenten über den bisherigen Low-Level-APIs für Aufgaben, Cloud-Extraktion und Daten. Verwenden Sie sie, wenn ein Agent oder eine Automatisierung eine geeignete Scraping-Vorlage finden, einen Lauf starten, den vom Server bereitgestellten Anweisungen für den nächsten Schritt folgen und Exportmetadaten abrufen soll, ohne jeden Low-Level-Endpunkt einzeln zu verknüpfen.

Neuer Scraping-Ablauf:

```text theme={null}
searchTemplates -> executeTask -> exportData
```

Ablauf für bestehende Aufgaben:

```text theme={null}
searchTasks -> startOrStopTask -> exportData
```

Neu bei AgentTools? Lesen Sie das [vollständige Workflow-Tutorial](https://helpcenter.octoparse.com/de/articles/15855832-run-a-scraping-workflow-with-the-octoparse-agenttools-api), um zu erfahren, wie Sie Vorlagen suchen, eine Aufgabe starten und Ergebnisse exportieren.

AgentTools-Antworten enthalten Geschäftsfelder innerhalb von `data`. Verwenden Sie `requestId` nur zur Fehlerbehebung und folgen Sie `retryGuidance`, `suggestedNextCall`, `workflow` und `toolHint`, statt Abfrageintervalle fest zu codieren.

<Info>
  Die AgentTools API erfordert eine Authentifizierung mit `x-api-key`. Einige Endpunkte erfordern außerdem `x-external-user-id`; die genauen Header finden Sie in der jeweiligen Endpunktreferenz.
</Info>

## Voraussetzungen

Für die Octoparse OpenAPI benötigen Sie ein **Standard-, Professional- oder Enterprise-Konto** mit mindestens einer funktionsfähigen Aufgabe. [Registrieren Sie sich hier](https://www.octoparse.de/signup), falls Sie noch kein Konto besitzen.

Aktuelle API-Version: **v1.0**

## Basis-URL

Alle Anfragen müssen für die Basis-URL URL-codiert sein:

```text theme={null}
https://openapi.octoparse.com
```

Platzhalter werden als `{xxxx}` dargestellt und müssen durch echte Werte ersetzt werden. Die Anfrage-URL für *Aufgabe suchen* lautet beispielsweise:

```text theme={null}
GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}
```

Wenn Ihre Aufgabengruppen-ID `abc` lautet, wird daraus `https://openapi.octoparse.com/task/search?taskGroupId=abc`.

## Ratenbegrenzungen

Octoparse begrenzt die API-Nutzung auf **20 Anfragen pro Sekunde**. Wenn Sie den Statuscode `429` erhalten, reduzieren Sie Ihre Anfragerate.

Eine erfolgreiche Antwort gibt HTTP `200` zurück. Informationen zu anderen Statuscodes finden Sie im Abschnitt [Referenzen](#) des jeweiligen Endpunkts.

## Berechtigungen

Stellen Sie sicher, dass Ihr Konto zur Nutzung des jeweiligen Dienstes berechtigt ist. Führen Sie andernfalls ein Upgrade Ihres Kontos durch.

| Dienst           | API                                                | Erforderlicher Plan                |
| ---------------- | -------------------------------------------------- | ---------------------------------- |
| Zugriffstoken    | Neues Token abrufen                                | Alle Benutzer                      |
| Zugriffstoken    | Token aktualisieren                                | Alle Benutzer                      |
| Aufgabengruppe   | Informationen zur Aufgabengruppe abrufen           | Standard, Professional, Enterprise |
| Aufgabe          | Aufgabe suchen                                     | Standard, Professional, Enterprise |
| Aufgabe          | Aufgabe duplizieren                                | Standard, Professional, Enterprise |
| Aufgabe          | Aufgabe verschieben                                | Standard, Professional, Enterprise |
| Aufgabe          | Aktionsparameter abrufen                           | Professional, Enterprise           |
| Aufgabe          | Aufgabenparameter aktualisieren                    | Professional, Enterprise           |
| Aufgabe          | Aktionsparameter aktualisieren                     | Professional, Enterprise           |
| Aufgabe          | Liste der Schleifenelemente aktualisieren          | Professional, Enterprise           |
| Aufgabe          | Aufgaben-URLs aktualisieren                        | Professional, Enterprise           |
| Cloud-Extraktion | Aufgabe starten                                    | Professional, Enterprise           |
| Cloud-Extraktion | Aufgabe stoppen                                    | Professional, Enterprise           |
| Cloud-Extraktion | Aufgabenstatus abrufen                             | Professional, Enterprise           |
| Cloud-Extraktion | Aufgabenstatus V2 abrufen                          | Professional, Enterprise           |
| Cloud-Extraktion | Status von Unteraufgaben abrufen                   | Professional, Enterprise           |
| Cloud-Extraktion | Unteraufgaben starten                              | Professional, Enterprise           |
| Cloud-Extraktion | Unteraufgaben stoppen                              | Professional, Enterprise           |
| Daten            | Nicht exportierte Daten abrufen                    | Standard, Professional, Enterprise |
| Daten            | Daten als exportiert markieren                     | Standard, Professional, Enterprise |
| Daten            | Daten nach Offset abrufen                          | Standard, Professional, Enterprise |
| Daten            | Daten eines bestimmten Batches nach Offset abrufen | Standard, Professional, Enterprise |
| Daten            | Daten entfernen                                    | Standard, Professional, Enterprise |

## Fehlerbehebung

Jede Antwort enthält eine `requestId`. Wenn eine Anfrage fehlschlägt, teilen Sie die `requestId` dem [Octoparse-Supportteam](mailto:support@octoparse.com) mit, um die Diagnose zu erleichtern.