Häufige Workflows - Devin Docs

Diese Seite beschreibt häufige End-to-End-Workflows mit der Devin API. Jeder Workflow umfasst die vollständige Abfolge von API-Aufrufen mit Codebeispielen. Einzelheiten zu den jeweiligen Endpunkten finden Sie auf den entsprechenden Seiten der API-Referenz.

Einrichtung

Legen Sie diese Umgebungsvariablen fest, bevor Sie ein Beispiel ausführen:

# Required: your service user API key (starts with cog_)
export DEVIN_API_KEY="cog_your_key_here"

# Required: your organization ID (find it on Settings > Service Users)
export DEVIN_ORG_ID="your_org_id"

Erste Schritte: vom API key bis zur ersten Sitzung

Der häufigste Workflow — authentifizieren Sie sich, ermitteln Sie Ihr Konto und erstellen Sie Ihre erste Sitzung.

Schritt 1: Überprüfen Sie Ihre Anmeldedaten

Service-Benutzer im org-Geltungsbereich können zu Schritt 3 wechseln — Sie kennen Ihre org-ID bereits von der Settings-Seite.

curl "https://api.devin.ai/v3/self" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Antwort:

{
  "principal_type": "service_user",
  "service_user_id": "service-user-abc123",
  "service_user_name": "CI Bot",
  "org_id": null
}

Schritt 2: Ihre Organisationen auflisten

Enterprise-Service-Benutzer können alle Organisationen auflisten:

curl "https://api.devin.ai/v3/enterprise/organizations" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Service-Benutzer im Org-Geltungsbereich kennen ihre Org-ID bereits (sie steht auf der Seite Settings → Service Users, auf der der Schlüssel erstellt wurde).

Schritt 3: Eine Sitzung erstellen

curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Create a Python script that analyzes CSV data"}'

Antwort:

{
  "session_id": "devin-abc123",
  "url": "https://app.devin.ai/sessions/devin-abc123",
  "status": "running"
}

Schritt 4: Auf Ereignisse pollen

Überwachen Sie die Sitzung, indem Sie Nachrichten regelmäßig pollen:

curl "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions/devin-abc123/messages" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Vollständiges Python-Beispiel

import os
import time
import requests

API_KEY = os.environ["DEVIN_API_KEY"]
ORG_ID = os.environ["DEVIN_ORG_ID"]
BASE = "https://api.devin.ai/v3"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}

# 1. Anmeldedaten überprüfen
me = requests.get(f"{BASE}/self", headers=HEADERS)
me.raise_for_status()
data = me.json()
print(f"Authenticated as: {data.get('service_user_name') or data.get('user_name')}")

# 2. Sitzung erstellen
session = requests.post(
    f"{BASE}/organizations/{ORG_ID}/sessions",
    headers={**HEADERS, "Content-Type": "application/json"},
    json={"prompt": "Create a Python script that analyzes CSV data"}
).json()
print(f"Session: {session['url']}")

# 3. Pollen bis zum Abschluss
while True:
    status = requests.get(
        f"{BASE}/organizations/{ORG_ID}/sessions/{session['session_id']}",
        headers=HEADERS
    ).json()["status"]
    print(f"Status: {status}")
    if status in ("exit", "error", "suspended"):
        break
    time.sleep(10)

Anhänge einer Sitzung herunterladen

Laden Sie Dateien herunter, die in einer Sitzung erstellt wurden (Logs, Screenshots, generierter Code usw.).

Schritt 1: Sitzung abrufen

curl "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions/$SESSION_ID" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Schritt 2: Anhänge auflisten

curl "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions/$SESSION_ID/attachments" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Antwort:

{
  "items": [
    {
      "attachment_id": "att_123",
      "name": "output.py",
      "url": "https://..."
    }
  ]
}

Schritt 3: Herunterladen

Verwenden Sie die url aus der Attachment-Antwort, um die Datei direkt herunterzuladen.

Vollständiges Python-Beispiel

import os
import requests

API_KEY = os.environ["DEVIN_API_KEY"]
ORG_ID = os.environ["DEVIN_ORG_ID"]
SESSION_ID = os.environ["SESSION_ID"]
BASE = "https://api.devin.ai/v3"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}

# Anhänge auflisten
attachments = requests.get(
    f"{BASE}/organizations/{ORG_ID}/sessions/{SESSION_ID}/attachments",
    headers=HEADERS
).json()["items"]

# Jeden Anhang herunterladen
for att in attachments:
    print(f"Downloading {att['name']}...")
    content = requests.get(att["url"]).content
    with open(att["name"], "wb") as f:
        f.write(content)
    print(f"  Saved {att['name']} ({len(content)} bytes)")

Verwaltung von Knowledge und Playbooks

Verwalten Sie den Kontext und die Anweisungen, die Devin sitzungsübergreifend verwendet.

Knowledge-Hinweis erstellen

curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/knowledge/notes" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Coding standards",
    "trigger": "When writing code in any repository",
    "body": "Use TypeScript strict mode. Follow existing code style. Run lint before committing."
  }'

Knowledge-Hinweise auflisten

curl "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/knowledge/notes" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Einen Knowledge-Hinweis aktualisieren

curl -X PUT "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/knowledge/notes/$NOTE_ID" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Coding standards (updated)",
    "trigger": "When writing code in any repository",
    "body": "Use TypeScript strict mode. Follow existing code style. Run lint and type-check before committing."
  }'

Einen Knowledge-Hinweis löschen

curl -X DELETE "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/knowledge/notes/$NOTE_ID" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Ein Playbook erstellen

curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/playbooks" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "PR Review",
    "body": "Review the PR for bugs, security issues, and style violations. Leave inline comments."
  }'

Vollständiges Beispiel in Python

import os
import requests

API_KEY = os.environ["DEVIN_API_KEY"]
ORG_ID = os.environ["DEVIN_ORG_ID"]
BASE = "https://api.devin.ai/v3"
HEADERS = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# Knowledge-Hinweis erstellen
note = requests.post(
    f"{BASE}/organizations/{ORG_ID}/knowledge/notes",
    headers=HEADERS,
    json={
        "name": "Coding standards",
        "trigger": "When writing code in any repository",
        "body": "Use TypeScript strict mode. Follow existing code style."
    }
).json()
print(f"Created note: {note['note_id']}")

# Alle Notizen auflisten
notes = requests.get(
    f"{BASE}/organizations/{ORG_ID}/knowledge/notes",
    headers={"Authorization": f"Bearer {API_KEY}"}
).json()["items"]
print(f"Total notes: {len(notes)}")

# Playbook erstellen
playbook = requests.post(
    f"{BASE}/organizations/{ORG_ID}/playbooks",
    headers=HEADERS,
    json={
        "title": "PR Review",
        "body": "Review the PR for bugs, security issues, and style violations."
    }
).json()
print(f"Created playbook: {playbook['playbook_id']}")

Automatisierte Sitzungen planen

Erstellen Sie wiederkehrende Sitzungen, die nach einem Zeitplan ausgeführt werden.

Zeitplan erstellen

curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/schedules" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekday test suite",
    "prompt": "Run the test suite and report any failures",
    "frequency": "0 9 * * 1-5"
  }'

Dadurch wird ein wiederkehrender Zeitplan erstellt, der an jedem Wochentag um 09:00 UTC ausgeführt wird. frequency ist ein standardmäßiger Cron-Ausdruck mit fünf Feldern und wird in UTC ausgewertet.

Zeitpläne auflisten

curl "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/schedules" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Zeitplan aktualisieren

curl -X PATCH "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "frequency": "0 8 * * 1-5",
    "enabled": true
  }'

Zeitplan löschen

curl -X DELETE "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

Vollständiges Python-Beispiel

import os
import requests

API_KEY = os.environ["DEVIN_API_KEY"]
ORG_ID = os.environ["DEVIN_ORG_ID"]
BASE = "https://api.devin.ai/v3"
HEADERS = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# Täglichen Health-Check-Zeitplan erstellen
schedule = requests.post(
    f"{BASE}/organizations/{ORG_ID}/schedules",
    headers=HEADERS,
    json={
        "name": "Daily health check",
        "prompt": "Run the test suite and report any failures",
        "frequency": "0 9 * * 1-5"
    }
).json()
print(f"Created schedule: {schedule['scheduled_session_id']}")

# Alle Zeitpläne auflisten
schedules = requests.get(
    f"{BASE}/organizations/{ORG_ID}/schedules",
    headers={"Authorization": f"Bearer {API_KEY}"}
).json()["items"]

for s in schedules:
    status = "enabled" if s.get("enabled") else "disabled"
    print(f"  {s['scheduled_session_id']}: {s['frequency']} ({status})")

Eine Aufgabe von überall an Devin übergeben

Da die Sessions API mit einer einzigen Anfrage eine Cloud-Devin-Sitzung erstellt, kann jedes Tool, Skript oder jeder Coding-Agent Arbeit an Devin “übergeben”, indem das aktuelle Repo, der Branch und nicht committete Änderungen im Prompt mitgegeben werden, sodass die Cloud-Sitzung dort anknüpft, wo Sie aufgehört haben.

Sitzung mit Repo-Kontext erstellen

# Den JSON-Body mit jq erstellen, damit der rohe Diff — der Anführungszeichen,
# Backslashes und Zeilenumbrüche enthält — in einen gültigen JSON-String escaped wird.
curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --arg diff "$(git diff HEAD)" \
    '{prompt: "Repo: my-org/my-repo (branch: fix-flaky-tests)\nFix the flaky integration tests in CI.\n\nUncommitted changes:\n\($diff)"}')"

Die Cloud-Sitzung klont das Repo, wendet den Kontext aus deinem Prompt an und läuft in ihrer eigenen VM mit einer Shell, einem Browser und vollständigem Repo-Zugriff. Du kannst sie verfolgen, indem du Nachrichten pollst oder in der Devin Web-App.

git diff HEAD kann nicht committete Secrets enthalten — API keys, Tokens oder Änderungen an .env — und der Prompt wird in die Cloud-Sitzung hochgeladen. Prüfe deinen Diff und committe, stash oder entferne sensible Änderungen, bevor du übergibst.

Du willst das nicht selbst einrichten? Das Open-Source-Plugin Devin Handoff bildet genau diesen Ablauf ab — Repo, Branch und Diff werden automatisch erkannt — sodass du direkt aus der Devin CLI, aus Claude Code, Codex, Cursor oder aus einem einfachen Shell-Skript an Devin übergeben kannst. Siehe An Devin übergeben.

Fehlerbehandlung

Alle obigen Beispiele sollten im Produktiveinsatz eine Fehlerbehandlung enthalten. Hier ist ein wiederverwendbares Muster:

import requests

def api_request(method, url, headers, **kwargs):
    """Make an API request with standard error handling."""
    response = requests.request(method, url, headers=headers, **kwargs)
    try:
        response.raise_for_status()
        return response.json()
    except requests.exceptions.HTTPError as e:
        status = e.response.status_code
        if status == 401:
            raise Exception("Invalid or expired API key")
        elif status == 403:
            raise Exception("Service user lacks required permission")
        elif status == 404:
            raise Exception("Resource not found")
        elif status == 429:
            raise Exception("Rate limit exceeded — wait and retry")
        else:
            raise Exception(f"API error {status}: {e.response.text}")

Support

Benötigen Sie Hilfe?

Bei Fragen zur API oder um issues zu melden, schreiben Sie an support@cognition.ai

​Einrichtung

​Erste Schritte: vom API key bis zur ersten Sitzung

​Schritt 1: Überprüfen Sie Ihre Anmeldedaten

​Schritt 2: Ihre Organisationen auflisten

​Schritt 3: Eine Sitzung erstellen

​Schritt 4: Auf Ereignisse pollen

​Vollständiges Python-Beispiel

​Anhänge einer Sitzung herunterladen

​Schritt 1: Sitzung abrufen

​Schritt 2: Anhänge auflisten

​Schritt 3: Herunterladen

​Vollständiges Python-Beispiel

​Verwaltung von Knowledge und Playbooks

​Knowledge-Hinweis erstellen

​Knowledge-Hinweise auflisten

​Einen Knowledge-Hinweis aktualisieren

​Einen Knowledge-Hinweis löschen

​Ein Playbook erstellen

​Vollständiges Beispiel in Python

​Automatisierte Sitzungen planen

​Zeitplan erstellen

​Zeitpläne auflisten

​Zeitplan aktualisieren

​Zeitplan löschen

​Vollständiges Python-Beispiel

​Eine Aufgabe von überall an Devin übergeben

​Sitzung mit Repo-Kontext erstellen

​Fehlerbehandlung

​Support

Benötigen Sie Hilfe?

Einrichtung

Erste Schritte: vom API key bis zur ersten Sitzung

Schritt 1: Überprüfen Sie Ihre Anmeldedaten

Schritt 2: Ihre Organisationen auflisten

Schritt 3: Eine Sitzung erstellen

Schritt 4: Auf Ereignisse pollen

Vollständiges Python-Beispiel

Anhänge einer Sitzung herunterladen

Schritt 1: Sitzung abrufen

Schritt 2: Anhänge auflisten

Schritt 3: Herunterladen

Vollständiges Python-Beispiel

Verwaltung von Knowledge und Playbooks

Knowledge-Hinweis erstellen

Knowledge-Hinweise auflisten

Einen Knowledge-Hinweis aktualisieren

Einen Knowledge-Hinweis löschen

Ein Playbook erstellen

Vollständiges Beispiel in Python

Automatisierte Sitzungen planen

Zeitplan erstellen

Zeitpläne auflisten

Zeitplan aktualisieren

Zeitplan löschen

Vollständiges Python-Beispiel

Eine Aufgabe von überall an Devin übergeben

Sitzung mit Repo-Kontext erstellen

Fehlerbehandlung

Support