Zum Inhalt springen

API-Referenz und Ausführung

Nutze den aktuellen OpenAPI-Vertrag, führe Operationen aus und kläre unterbrochene Anfragen.

HTTP-API und MCP teilen Verträge für Operationen, die auf beiden Schnittstellen verfügbar sind. Die HTTP-API bietet zusätzlich direkte Katalog- und Anbieteroperationen; der öffentliche MCP-Server stellt Recherche-Einstiege und Sheet-Verwaltung bereit. Nutze HTTP für deine Anwendung und MCP für einen kompatiblen KI-Client. Beide prüfen Workspace-Zugriff und Abrechnung.

Vertrag entdecken

AnfrageZweck
GET /api/v1/openapi.jsonÖffentliches OpenAPI-3.1-Dokument; Schemas ohne Key lesen
GET /api/v1/operationsAuthentifizierter Operationskatalog, gefiltert nach deinem Zugriff
GET /api/v1/operations/{id}Aktuelle Eingabe- und Ausgabeschemas
POST /api/v1/operations/{id}Ausführung mit schema-konformem JSON-Body

HTTP-Operations-IDs verwenden Punkte, beispielsweise enrichment.start. Gemeinsame MCP-Tools verwenden Unterstriche, beispielsweise enrichment_start. Maßgeblich ist die MCP-Tool-Liste: Das Ersetzen von Punkten durch Unterstriche macht ein nicht gelistetes Tool nicht aufrufbar. Ermittle genaue IDs und Parameter, statt sie aus Titeln abzuleiten. Sende unkomprimiertes application/json; die Grenze pro Request-Body beträgt 1 MiB.

Eine vollständige erste Anfrage findest du unter typisiertes Enrichment. Nutze anschließend API-Authentifizierung und Bulk-Abruf.

Recherche über HTTP oder MCP

Nutze sheets.research (sheets_research in MCP) für eine neue gespeicherte Liste, sheets.enrich (sheets_enrich) für eine vorhandene Sheet-Spalte und enrichment.start (enrichment_start) für 1–100 unabhängige Elemente ohne Sheet. Der gemeinsame Enrichment-Endpunkt unterstützt viele E-Mail- und Telefonanfragen im selben Batch. Siehe das Bulk-Kontaktbeispiel und die MCP-Einrichtung.

Ein Katalog-Tool über HTTP ausführen

Die folgenden direkten Katalogoperationen sind auf der öffentlichen Integrationsschnittstelle nur über HTTP verfügbar. Sende zuerst {"query":"search"} an /api/v1/operations/tools.list. Wähle ein verfügbares Tool aus der Antwort und prüfe sein inputSchema. Sende anschließend an /api/v1/operations/tools.run:

json
{  "toolId": "ID_FROM_TOOLS_LIST",  "parameters": {},  "idempotencyKey": "catalog-task-001"}

Ersetze den Platzhalter und ergänze in parameters die vom Tool geforderten Felder; das leere Objekt zeigt nur die Struktur. Die Antwort enthält das vollständige Provider-Ergebnis, die Versuche und die tatsächlichen Provider-Kosten. Einzelne Endpunkte werden direkt ausgeführt; Gruppen nutzen ihren konfigurierten Waterfall. Beide Wege benötigen keine Recherche-Modellrunde. Dieselbe Anfrage mit demselben Idempotenzschlüssel liefert die gespeicherte Antwort ohne weitere Provider-Kosten.

Fehler gezielt behandeln

StatusAktion
400Eingabe anhand des aktuellen Schemas korrigieren
401Gültigkeit des Keys oder OAuth-Token und Zielressource prüfen
403Mitgliedschaft, Scopes, Berechtigung und Workspace-Regeln prüfen
404Operations-, Tool- oder Ressourcen-ID prüfen
409Ursprüngliche Anfrage und Wiederholungsschlüssel prüfen
413 / 415Body verkleinern oder unterstütztes JSON senden
429Mit Abstand wiederholen und Wiederholungshinweise beachten
5xxAusgang der ursprünglichen Anfrage klären, bevor kostenpflichtige Arbeit erneut startet

Ein erfolgreicher Transport beweist keinen Treffer. Prüfe fachlichen Status, Fehlercodes, Werte und Abrechnungsstand. Bewahre die IDs aus der Antwort auf. Nutze bei unklarem Ausgang denselben Idempotenzschlüssel und identischen Body; ein neuer Schlüssel kann neue kostenpflichtige Arbeit auslösen. Siehe Fehlerbehebung.