# SERP-API: KI-Zusammenfassung

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/ai_summary`

**Tags:** DataForSEO

Gibt die KI-Übersicht zurück, die Google für eine Abfrage über den Ergebnissen bei Google anzeigt. Gibt `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` und `items` zurück. Eingebettet in die DataForSEO-Hülle: Daten in `tasks[0].result`, Ergebnis in `tasks[0].status_code` – eine abgelehnte Anfrage gibt dennoch HTTP 200 zurück.

### Preisreferenz

- Abrechnung: Gemeldete Antwortkosten.
- Referenzschätzung pro Anfrage: USD 0.02.
- Referenz-Kundenmultiplikator: 1.0. Nicht erneut auf einen abgerechneten Kundenbetrag anwenden.

Nur Referenzmetadaten, kein Kontenangebot, kein garantierter Preis und keine Ausgabenobergrenze. Ressourcen-Credits sind keine Felo-Credits. Endgültige Abrechnungen richten sich nach den Felo-Abrechnungsbelegen.

## Related links

- [UUID](<https://en.wikipedia.org/wiki/Universally_unique_identifier>)

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "task_id": {
            "type": "string",
            "description": "<em>Aufgaben-ID</em><br><strong>Pflichtfeld</strong><br>eindeutige ID der zugehörigen Aufgabe im UUID-Format<br>Sie können sie <strong>30 Tage</strong> lang verwenden, um die Ergebnisse der Aufgabe jederzeit abzurufen"
          },
          "prompt": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>KI-Prompt</em><br>Optionales Feld<br>zusätzliche Aufgabe für den KI-Zusammenfasser;<br>jede Form von Text, Frage oder Information, die der KI mitteilt, welche Antwort Sie suchen;<br>maximale Anzahl von Symbolen oder Zeichen, die Sie angeben können: <code>2000</code>;<br><strong>Hinweis:</strong> Ihr Prompt muss für das in der POST-Anfrage an die SERP API angegebene Keyword relevant sein"
          },
          "support_extra": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>zusätzliche SERP-Features unterstützen</em><br>Optionales Feld<br>bei <code>true</code> berücksichtigt das KI-Modell zusätzlich zu den <code>organic</code>-Ergebnissen die folgenden zusätzlichen SERP-Features: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>Standardwert: <code>true</code>"
          },
          "fetch_content": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>Inhalte von Seiten in SERPs abrufen</em><br>Optionales Feld<br>bei <code>true</code> ruft die API die Inhalte der in den SERP-Ergebnissen aufgeführten Seiten ab, und das KI-Modell berücksichtigt diese Inhalte bei der Erstellung der Zusammenfassung im Ergebnis;<br>Standardwert: <code>false</code>"
          },
          "include_links": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>Quellenlinks in die Zusammenfassung aufnehmen</em><br>Optionales Feld<br>bei <code>true</code> enthält das Feld <code>summary</code> in der API-Antwort Links zu den Quellen der generierten Zusammenfassung;<br>Standardwert: <code>false</code>"
          }
        },
        "example": [
          {
            "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
            "prompt": "explain what DataForSEO is",
            "include_links": true,
            "fetch_content": true
          }
        ]
      }
    ]
  },
  "example": [
    {
      "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
      "prompt": "explain what DataForSEO is",
      "include_links": true,
      "fetch_content": true
    }
  ]
}
```

## Responses

### 200 — Erfolgreicher Vorgang

Headers:
- `X-Request-Id` (string) — Anfragekennung, die Sie beim Kontakt mit dem Felo-Support angeben sollten.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryResponseInfo"
    }
  ]
}
```

### 400 — Die Anfrage konnte nicht verarbeitet werden. Prüfen Sie die Anfrageparameter.

### 401 — Ein gültiger Felo-API-Schlüssel ist erforderlich.

### 402 — Die Anfrage kann nicht fortgesetzt werden, da eine Abrechnungsvoraussetzung nicht erfüllt ist.

### 403 — Das Konto ist für diesen Vorgang nicht berechtigt.

### 429 — Ein Anfrage- oder Ausgabenlimit wurde erreicht.

### 502 — Der Dienst konnte die Anfrage nicht abschließen.

### 503 — Die API oder der Abrechnungsdienst ist vorübergehend nicht verfügbar.

### 504 — Beim Verarbeiten der Anfrage ist eine Zeitüberschreitung aufgetreten.

### default — Fehlerantwort; Upstream-Passthrough-Antworten können Anbieterformate verwenden

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "Die aktuelle Version der API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "allgemeiner Statuscode\ndie vollständige Liste der Antwortcodes finden Sie hier"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "allgemeine Informationsmeldung\ndie vollständige Liste der allgemeinen Informationsmeldungen finden Sie hier"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "Gesamtausführungszeit, Sekunden"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "Gesamtkosten der Aufgaben in USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Die Anzahl der Aufgaben im tasks-Array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Die Anzahl der Aufgaben im tasks-Array, die mit einem Fehler zurückgegeben wurden",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Aufgaben-ID\neindeutige Aufgaben-ID in unserem System im UUID-Format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Statuscode der Aufgabe\nvon DataForSEO erzeugt, kann im folgenden Bereich liegen: 10000-60000\ndie vollständige Liste der Antwortcodes finden Sie hier"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Informationsmeldung der Aufgabe\ndie vollständige Liste der allgemeinen Informationsmeldungen finden Sie hier"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "Ausführungszeit in Sekunden"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "Gesamtkosten der Aufgaben in USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Anzahl der Elemente im Ergebnis-Array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL-Pfad"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "Enthält dieselben Parameter, die Sie in der POST-Anfrage angegeben haben"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryItem

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryItem`

```json
{
  "type": "object",
  "properties": {
    "summary": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>generierte Zusammenfassung</em><br>vom KI-Modell gemäß den in der Anfrage angegebenen Parametern generierte Zusammenfassung"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryTaskInfo"
              }
            ]
          },
          "description": "<em>Array von Aufgaben</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpAiSummaryResultInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryResultInfo`

```json
{
  "type": "object",
  "properties": {
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>Anzahl der Einträge im Ergebnis-Array</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryItem"
          }
        ]
      },
      "description": "<em>Array der Einträge</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryResultInfo"
              }
            ]
          },
          "description": "<em>Array von Ergebnissen</em>"
        }
      }
    }
  ]
}
```
