JieGou war immer eine visuelle Plattform — Sie erstellen Recipes und Workflows im Browser, führen sie mit einem Klick aus und sehen Ergebnisse in Echtzeit. Aber was, wenn Sie einen Workflow aus einer GitHub Action auslösen möchten? Oder ein Recipe aus einem Slack-Bot ausführen? Oder JieGou-Ausführung in Ihre bestehende CI/CD-Pipeline einbetten?
Heute starten wir die SDK-API — eine Headless-Ausführungsschicht, mit der Sie alles in JieGou programmatisch ausführen können.
Ein Endpunkt, vier Aktionen
Die SDK-API ist ein einzelner einheitlicher Endpunkt unter POST /api/sdk. Authentifizieren Sie sich mit einem Bearer-Token, geben Sie eine Aktion an und erhalten Sie Ergebnisse:
# Ein Recipe synchron ausführen
curl -X POST https://console.jiegou.ai/api/sdk \
-H "Authorization: Bearer jg_a7f2b1c3e9d4..." \
-H "Content-Type: application/json" \
-d '{
"action": "run_recipe",
"recipeId": "abc123",
"input": { "topic": "AI-Trends 2026" }
}'
Vier Aktionen sind verfügbar:
| Aktion | Was sie macht | Antwort |
|---|---|---|
run_recipe | Ein einzelnes Recipe ausführen | Synchron — gibt Ergebnis sofort zurück |
run_workflow | Einen mehrstufigen Workflow ausführen | Asynchron — gibt runId zum Polling zurück |
run_coding_agent | Eine Coding-Agent-Aufgabe ausführen | Asynchron — gibt runId mit Streaming zurück |
send_message | Eine Nachricht an eine Konversation senden | Synchron — gibt Assistenten-Antwort zurück |
API-Schlüssel mit granularen Berechtigungen
SDK-API-Schlüssel sind getrennt von Ihren LLM-Anbieter-Schlüsseln (BYOK). Erstellen Sie sie von der Kontoeinstellungsseite mit Scope-bezogenen Berechtigungen:
recipes:read/recipes:executeworkflows:read/workflows:executeruns:readconversations:read/conversations:writecoding-agent:executeskills:read
Schlüssel verwenden das jg_-Präfix zur einfachen Identifikation in Logs und Secret-Scannern. Das Klartext-Token wird nur bei der Erstellung angezeigt — danach sind nur die ersten 8 Zeichen sichtbar. Schlüssel werden als SHA-256-Hashes gespeichert, nie im Klartext.
Jeder Schlüssel kann ein optionales Ablaufdatum haben. Rotieren Sie Schlüssel sofort — das alte Token wird widerrufen und ein neues mit derselben Konfiguration generiert.
Asynchrone Ausführung mit Polling und Streaming
Workflows und Coding-Agent-Aufgaben laufen asynchron. Die initiale Antwort gibt Ihnen eine runId und eine pollUrl:
{
"status": "queued",
"runId": "run_xyz789",
"pollUrl": "/api/sdk/runs/run_xyz789"
}
Auf Status pollen:
curl https://console.jiegou.ai/api/sdk/runs/run_xyz789 \
-H "Authorization: Bearer jg_a7f2b1c3..."
Oder Echtzeit-Events per SSE streamen:
curl -N https://console.jiegou.ai/api/sdk/runs/run_xyz789/stream \
-H "Authorization: Bearer jg_a7f2b1c3..." \
-H "Accept: text/event-stream"
Events umfassen Schritt-Starts, Schritt-Abschlüsse, Coding-Agent-Tool-Aufrufe und das Endergebnis.
Rate-Limiting und Nutzungstracking
Jeder API-Schlüssel hat eigene Rate-Limits:
- 60 Anfragen pro Minute pro Schlüssel
- 1.000 Anfragen pro Stunde pro Schlüssel
- 10 gleichzeitige Anfragen pro Schlüssel
SDK-Nutzung wird im Billing-Dashboard getrennt von der Web-UI-Nutzung verfolgt, aufgeschlüsselt nach API-Schlüssel und Aktionstyp. Token-Verbrauch fließt in dasselbe BYOK-Billing wie die Web-Nutzung.
Integrationsbeispiele
GitHub Actions
- name: Changelog generieren
run: |
curl -X POST $JIEGOU_URL/api/sdk \
-H "Authorization: Bearer ${{ secrets.JIEGOU_SDK_KEY }}" \
-d '{"action": "run_recipe", "recipeId": "changelog-gen", "input": {"diff": "${{ steps.diff.outputs.content }}"}}'
Slack-Bot
app.message('summarize', async ({ message, say }) => {
const result = await fetch(`${JIEGOU_URL}/api/sdk`, {
method: 'POST',
headers: { 'Authorization': `Bearer ${JIEGOU_KEY}` },
body: JSON.stringify({
action: 'run_recipe',
recipeId: 'thread-summarizer',
input: { thread: message.text },
}),
});
const data = await result.json();
await say(data.result.output);
});
Geplante Batch-Verarbeitung
#!/bin/bash
# Nächtlichen Datenverarbeitungs-Workflow ausführen
RESPONSE=$(curl -s -X POST "$JIEGOU_URL/api/sdk" \
-H "Authorization: Bearer $JIEGOU_KEY" \
-d '{"action": "run_workflow", "workflowId": "nightly-etl", "input": {"date": "'$(date -I)'"}}')
RUN_ID=$(echo $RESPONSE | jq -r '.runId')
# Pollen bis abgeschlossen
while true; do
STATUS=$(curl -s "$JIEGOU_URL/api/sdk/runs/$RUN_ID" \
-H "Authorization: Bearer $JIEGOU_KEY" | jq -r '.status')
[ "$STATUS" = "completed" ] && break
[ "$STATUS" = "failed" ] && exit 1
sleep 10
done
Ab sofort verfügbar
Die SDK-API ist ab Pro-Plänen und höher verfügbar. Erstellen Sie Ihren ersten API-Schlüssel unter Kontoeinstellungen > SDK-API-Schlüssel.
Wir arbeiten auch an einem npm-Paket (@jiegou/sdk), das die REST-API mit TypeScript-Typen, Streaming-Helfern und automatischer Retry-Logik umhüllt. Bleiben Sie dran.
Einen API-Schlüssel erstellen und mit der Automatisierung Ihrer Automatisierungen beginnen.