Meld dich jetzt für den kostenlosen Toolkiste Newsletter an! Den erhältst du jeden Donnerstag mit vielen Empfehlungen für Tools, Schritt-für-Schritt-Tutorials und exklusiven Deals und Rabattcodes.
Als Dankeschön erhältst du direkt nach der Anmeldung die Toolliste mit 78 Empfehlungen für Tools rund um Online-Business!
Wenn du mit Custom GPTs arbeitest und diesen mithilfe der Aktionen ermöglichen willst, mit anderen Tools zu kommunizieren, kommst du um das OpenAPI Schema nicht herum.
Aber was ist dieses Schema überhaupt, und wie funktioniert es?
Wichtig zuerst: Verwechsle nicht OpenAPI mit OpenAI!
Letzteres ist das Unternehmen hinter ChatGPT – das hat aber nichts mit dem OpenAPI Schema zu tun. Das OpenAPI Schema ist vielmehr eine standardisierte Beschreibung, die den Bauplan für eine API darstellt.
In diesem Artikel erfährst du, was genau hinter diesem Schema steckt und wie du es für deine Custom GPTs nutzen kannst.
Und keine Sorge: Du musst solche Schemas nicht selbst von Grund auf schreiben können. Es ist aber trotzdem hilfreich zu verstehen, wie sie aufgebaut sind, damit du sie besser einsetzen kannst!
Was steckt hinter den Aktionen in GPTs?
Bevor wir ins Detail des Schemas gehen, schauen wir uns erst einmal an, wofür du die Aktionen in GPTs überhaupt brauchst.
Über eine Aktion kannst du deinen GPT mit externen Tools verknüpfen und ihm ermöglichen, bestimmte Funktionen auszuführen.
Ein praktisches, ganz simples Beispiel: Du könntest einen GPT erstellen, der als Terminplaner fungiert. Wenn du diesem GPT sagst "Neuer Termin, Weekly Check-in am 28. Februar von 11 bis 12 Uhr", kann er direkt einen entsprechenden Termin in deinem Google-Kalender anlegen.
Er kommuniziert also mit einem externen Tool – in diesem Fall dem Google-Kalender – und führt dort Aktionen für dich durch.
Du könntest einen solchen GPT theoretisch auch noch so einstellen, dass er Termine bearbeiten oder löschen kann. Im Grunde genommen managt er also deinen Kalender auf Basis deiner Anweisungen.
Diese Kommunikation zwischen deinem GPT und dem externen Tool erfolgt über eine API.
Was ist eine API?
Eine API (kurz für Application Programming Interface) ermöglicht die Kommunikation zwischen zwei oder mehr unterschiedlichen Tools, Anwendungen oder Systemen.
Sie sorgt dafür, dass Daten und Informationen ausgetauscht werden können, auch wenn die beteiligten Systeme eigentlich nichts miteinander zu tun haben und von unterschiedlichen Entwicklern oder Unternehmen stammen.
Im Alltag begegnen dir APIs ständig, auch wenn dir das vielleicht gar nicht bewusst ist:
- Wenn du etwas in einem Onlineshop bestellst und das Paket per DHL verschickt wird, werden die Bestelldaten über eine API an den Versanddienstleister übermittelt.
- Wenn du bei einer Flugsuchmaschine nach Flügen suchst, werden dir Angebote von verschiedenen Airlines angezeigt. Diese Daten werden über APIs der jeweiligen Fluggesellschaften abgefragt und dann in der Suchmaschine für dich aufbereitet.
APIs sorgen also für einen reibungslosen Datenaustausch zwischen verschiedenen Systemen und ermöglichen so viele der digitalen Dienste, die wir täglich nutzen.
Das OpenAPI Schema im Detail
Das OpenAPI Schema, das du bei deinem Custom GPT bei einer Aktion einfügst, beschreibt und dokumentiert genau diese API.
Es ist eine standardisierte Beschreibung, die aufzeigt, wohin die Daten geschickt werden, welche Informationen versendet werden und wie die Kommunikation insgesamt abläuft. Du kannst es dir wie einen Bauplan für die API vorstellen.
Schauen wir uns anhand eines einfachen Beispiels für eine Wetter-App an, wie so ein Schema aufgebaut ist.
Server-URL
Zuerst enthält das Schema Informationen darüber, über welchen Server die API erreichbar ist. Diese URL muss in jedem OpenAPI Schema enthalten sein. Sie gibt an, wohin die Anfragen geschickt werden sollen.
"servers": [
{
"url": "https://wetterapi.beispiel.de"
}
]
Pfade/Endpunkte
Als nächstes definiert das Schema die sog. Pfade oder Endpunkte – das sind die einzelnen Aktionen, die über die API ausgeführt werden können. Bei unserem Wetter-Beispiel könnte das so aussehen:
"paths": {
"/wetter": {
"get": {
...
}
}
}
Das "/wetter" wird an die Server-URL angehängt, um den entsprechenden Endpunkt zu erreichen. Es sagt dem Server, welche Aktion ausgeführt werden soll – in diesem Fall die Abfrage des Wetters für eine bestimmte Stadt.
Methoden
Dann steht im Schema die Methode, die bei der Anfrage verwendet wird. Es gibt verschiedene HTTP-Methoden, die bei APIs eingesetzt werden können:
- GET: Zum Abrufen von Daten (wie in unserem Wetter-Beispiel)
- POST: Zum Erstellen neuer Daten
- PUT oder PATCH: Zum Aktualisieren bestehender Daten
- DELETE: Zum Löschen von Daten
Bei unserem Wetter-Beispiel wird die GET-Methode verwendet, weil wir Daten (nämlich die Wetterinformationen) abrufen wollen.
Parameter
Als nächstes definiert das Schema, welche Informationen bei der Anfrage übermittelt werden müssen, damit die gewünschte Aktion ausgeführt werden kann. Diese werden als Parameter bezeichnet.
"parameters": [
{
"name": "stadt",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Die Stadt, für die Wetterdaten abgefragt werden sollen"
}
]
In unserem Wetter-Beispiel gibt es nur einen Parameter, nämlich die Stadt, für die die Wetterinformationen abgefragt werden sollen. Es handelt sich hier um eine Pflichtangabe ("required": true) – ist ja logisch, woher soll die API sonst wissen, welche Wetterdaten du konkret haben willst?
Je nach API können auch mehrere Parameter erforderlich sein.
Beim Google-Kalender-Beispiel von vorhin wären zum Beispiel mehrere Parameter nötig: welcher Kalender verwendet werden soll, wie der neue Termin heißen soll und wann er stattfindet.
Antworten
Schließlich gibt das Schema auch an, welche Art von Antwort du auf deine Anfrage erwarten kannst, wenn alles funktioniert:
"responses": {
"200": {
"description": "Erfolgreiche Abfrage der Wetterdaten",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"temperatur": {
"type": "number",
"description": "Aktuelle Temperatur in Grad Celsius"
}
}
}
}
}
}
}
In diesem Fall würdest du als Antwort ein Objekt mit einer Eigenschaft "temperatur" erhalten, die die aktuelle Temperatur als Zahl angibt.
Komplexere Beispiele
Natürlich kann ein OpenAPI Schema auch wesentlich komplexer sein als dieses einfache Beispiel (in den allermeisten Fällen wird das auch so sein).
Es kann detailliertere Angaben zu den benötigten Daten enthalten, Informationen zur Fehlerbehandlung, Sicherheitseinstellungen wie Authentifizierungsmethoden und vieles mehr.
Wenn du aber den grundsätzlichen Aufbau verstanden hast, kannst du auch in komplexeren Schemas die wichtigsten Informationen erkennen und nutzen!
Ein OpenAPI Schema erstellen
Wie kannst du nun selbst ein OpenAPI Schema erstellen, wenn du deinem GPT eine Aktion hinzufügen willst? Glücklicherweise musst du das nicht komplett von Grund auf selbst machen.
Ich hab nämlich einen Custom GPT entwickelt, der dich Schritt für Schritt durch die Erstellung eines OpenAPI Schemas führt! Du startest einfach mit dem Klick auf den Button "Neues OpenAPI Schema erstellen" und wirst dann durch den gesamten Prozess geleitet.
Der Ablauf sieht ungefähr so aus:
- Zuerst wirst du nach allgemeinen Informationen gefragt: Name, Beschreibung und Versionsnummer deiner API.
- Dann gibst du die Server-Informationen an, also die URL, wohin die Daten geschickt werden sollen.
- Anschließend definierst du die Details der Aktionen, die ausgeführt werden sollen.
- Für jeden Parameter gibst du an, wie er heißen soll, ob er ein Pflichtfeld ist, welchen Typ er hat (z.B. String, Zahl, Boolean) und in welchem Format er vorliegen soll.
- Schließlich legst du fest, welche Nachrichten angezeigt werden sollen, wenn die Aktion erfolgreich ausgeführt wurde oder wenn ein Fehler aufgetreten ist.
- Am Ende bekommst du eine Zusammenfassung aller Angaben und das fertige OpenAPI Schema.
Der gesamte Prozess ist darauf ausgelegt, so einfach wie möglich zu sein. Und falls du bei irgendeinem Schritt unsicher bist, kannst du den GPT jederzeit um Hilfe bitten.
OpenAPI Schema in Custom GPTs implementieren
Wenn du dein OpenAPI Schema erstellt hast, musst du es noch bei deinem Custom GPT implementieren.
Dafür klickst du beim Erstellen oder Bearbeiten deines GPTs auf "Create new action" (Neue Aktion erstellen), woraufhin sich ein Fenster öffnet, in das du dein Schema einfügen kannst.
Nach dem Einfügen des Schemas werden dir darunter direkt die verfügbaren Aktionen angezeigt. Du kannst den Namen der Aktion sehen, die Methode, die dabei verwendet wird (z.B. GET oder POST), und den Pfad bzw. Endpunkt.
Um sicherzustellen, dass alles richtig funktioniert, hast du die Möglichkeit, die implementierte Aktion direkt zu testen. So kannst du überprüfen, ob dein GPT korrekt mit dem externen Tool kommunizieren kann und die gewünschten Ergebnisse liefert.
Das OpenAPI Schema mag auf den ersten Blick kompliziert erscheinen, aber mit etwas Grundverständnis und den passenden Tools (z.B. dem OpenAPI Schema Creator) kannst du es effektiv nutzen, um deinen Custom GPTs neue Funktionalitäten zu verleihen!
