​

Die meinGPT Workflows API

Die meinGPT Workflows API ermöglicht es Workflows programmatisch auszuführen. Dies ist besonders nützlich, wenn Workflows in bestehende Systeme integriert werden sollen.

​

Authorization

Anfragen an die meinGPT API müssen mit einem API-Token authentifiziert werden. Diesen kannst du bei deinen persönlichen Einstellungen in der meinGPT-Plattform generieren.

Dieser Token muss bei allen Anfragen im ‘Authorization’ Header als bearer token mitgeschickt werden.

Beispiel:

Authorization: Bearer sk_meingpt_1234567890

​

Workflows ausführen

Der endpunkt zum Ausführen von Workflows ist unter dem “API” Tab in der meinGPT-Platform bei dem bearbeiten eines Workflows zu finden.

Anfragen müssen immer als “POST” an diesen Endpunkt gesendet werden.

​

Request Body

Der Inhalt des Request Body muss ein JSON-Objekt sein, welches die Eingabeparameter des Workflows enthält:

{
  "input": {
    "variable-1": "Wert 1",
    "variable-2": "Wert 2",
    "toggle-wert-3": true
  },
  "language": "de" // Optionale Angabe der Sprache (als ISO 639-1 Code)
}

Bitte vergiss nicht, den entprechenden Content-Type Header zu setzen:

Content-Type: application/json

​

Spracheinstellung

Optional kann eine Sprache als ISO 639-1 Code im “language” Feld angegeben werden (Standardwert ist “de”). Dieser Wert kann einen Einfluss auf den System Prompt und den Context haben, der von meinGPT automatisch generiert und der prompt angehängt wird. Es hat den selbern Effekt, wie die Spracheinstellung in der meinGPT-Plattform.

Mögliche Werte sind: en, de, es, it, fr

​

Response

​

Erfolgreiche Ausführung

Status Code: 2xx

{
  "status": "success",
  "workflowId": "cm3g1hs780001jjv3pzrputld",
  "input": {
    "name": "Alice"
  },
  "response": [
    // die Nachrichten des Workflows in chronologischer Reihenfolge
    {
      "content": "Grüße Alice sehr herzlich.",
      "role": "user"
    },
    {
      "content": "Natürlich! Hier ist eine Nachricht, die du an Alice senden kannst:\n\n---\n\n**Betreff:** Herzliche Grüße\n\nLiebe Alice,\n\nich hoffe, es geht dir gut! Ich möchte dir ganz herzliche Grüße ausrichten und wünsche dir alles Gute. \n\nFreue mich auf unser nächstes Treffen!\n\nLiebe Grüße,  \n[Dein Name]\n\n--- \n\nFühl dich frei, den Text nach deinem Bedarf anzupassen!",
      "role": "assistant",
      "model": "gpt-4o-mini"
    }
  ]
}

Typescript Type Definition:

type WorkflowResponse = {
  status: string;
  workflowId: string;
  input: Record<string, string | boolean>;
  response: Array<{
    content: string;
    role: string;
    model?: string; // Optional property for model
  }>;
};

​

Möglicher Fehler

Status Code: 4xx, 5xx

Bei einem Fehler wird kein JSON-Objekt zurückgegeben, sondern eine Fehlermeldung in Textform.