よくあるフロー

このページでは、Devin APIを利用した一般的なエンドツーエンドのワークフローを紹介します。各フローには、コード使用例とあわせて、APIコールの一連の流れがすべて含まれています。各エンドポイントの詳細については、該当するAPIリファレンスページを参照してください。

セットアップ

いずれの使用例を実行する前にも、これらの環境変数を設定してください。

# 必須: サービスユーザーのAPIキー（cog_ で始まります）
export DEVIN_API_KEY="cog_your_key_here"

# 必須: 組織ID（Settings > Service Users で確認できます）
export DEVIN_ORG_ID="your_org_id"

はじめに: APIキーから最初のセッションまで

最も一般的なワークフローです。認証を行い、アカウント情報を確認して、最初のセッションを作成します。

ステップ 1: 認証情報を確認する

組織スコープのサービスユーザーはステップ 3 に進んでください。org ID は Settings ページですでに確認済みです。

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

レスポンス:

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

ステップ 2: 自分の組織を一覧表示する

Enterprise のサービスユーザーは、すべての組織を一覧表示できます。

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

組織スコープのサービスユーザーは、すでに自身の org ID を把握しています (キーを作成した Settings > Service Users ページに記載されています) 。

ステップ 3: セッションを作成する

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"}'

レスポンス:

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

ステップ 4: イベントをポーリングする

メッセージをポーリングして、セッションを監視します:

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

Pythonの完全な例

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. 認証情報を確認する
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. セッションを作成する
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. 完了するまでポーリングする
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)

セッションの添付ファイルをダウンロード

セッションで生成されたファイル (ログ、スクリーンショット、生成コードなど) を取得します。

ステップ 1: セッションを取得する

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

ステップ 2: 添付ファイルを一覧表示する

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

レスポンス:

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

ステップ 3: ダウンロード

添付ファイルのレスポンスに含まれる url を使用して、ファイルを直接ダウンロードします。

Pythonの完全な使用例

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}"}

# 添付ファイルを一覧表示する
attachments = requests.get(
    f"{BASE}/organizations/{ORG_ID}/sessions/{SESSION_ID}/attachments",
    headers=HEADERS
).json()["items"]

# 各添付ファイルをダウンロードする
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)")

Knowledge と playbook の管理

Devin がセッションをまたいで利用する前提情報と指示を管理します。

Knowledgeノートを作成する

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ノートを一覧表示する

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

Knowledgeノートを更新する

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."
  }'

Knowledgeノートを削除する

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

playbook を作成する

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 '{
    "name": "PR Review",
    "instructions": "Review the PR for bugs, security issues, and style violations. Leave inline comments."
  }'

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 ノートを作成する
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']}")

# すべてのノートを一覧表示する
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 = requests.post(
    f"{BASE}/organizations/{ORG_ID}/playbooks",
    headers=HEADERS,
    json={
        "name": "PR Review",
        "instructions": "Review the PR for bugs, security issues, and style violations."
    }
).json()
print(f"Created playbook: {playbook['playbook_id']}")

自動セッションのスケジュール設定

スケジュールに沿って実行される定期セッションを作成します。

スケジュールを作成する

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 '{
    "prompt": "Run the test suite and report any failures",
    "cron_schedule": "0 9 * * 1-5",
    "timezone": "America/New_York"
  }'

これにより、米国東部時間の平日午前9時に実行されるスケジュールが作成されます。

スケジュールを一覧表示する

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

スケジュールを更新する

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 '{
    "cron_schedule": "0 8 * * 1-5",
    "is_enabled": true
  }'

スケジュールを削除する

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

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"
}

# 毎日のヘルスチェックスケジュールを作成する
schedule = requests.post(
    f"{BASE}/organizations/{ORG_ID}/schedules",
    headers=HEADERS,
    json={
        "prompt": "Run the test suite and report any failures",
        "cron_schedule": "0 9 * * 1-5",
        "timezone": "America/New_York"
    }
).json()
print(f"Created schedule: {schedule['schedule_id']}")

# すべてのスケジュールを一覧表示する
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("is_enabled") else "disabled"
    print(f"  {s['schedule_id']}: {s['cron_schedule']} ({status})")

エラー処理

本番環境では、上記のすべての使用例にエラー処理を含める必要があります。以下に、再利用可能なパターンを示します。

import requests

def api_request(method, url, headers, **kwargs):
    """標準的なエラー処理を含むAPIリクエストを実行する。"""
    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("APIキーが無効または期限切れです")
        elif status == 403:
            raise Exception("サービスユーザーに必要なpermissionがありません")
        elif status == 404:
            raise Exception("リソースが見つかりません")
        elif status == 429:
            raise Exception("レート制限を超過しました — しばらく待ってから再試行してください")
        else:
            raise Exception(f"APIエラー {status}: {e.response.text}")

サポート

お困りですか？

API に関するご質問や問題の報告は、support@cognition.ai までメールでお問い合わせください

はじめに

基本概念

Agent のライフサイクル

前提情報の管理

環境の管理

自動化

統合

アナリティクス

可観測性

インフラストラクチャ

アイデンティティとアクセス

設定

レガシーAPI v1

レガシーAPI v2

Documentation Index

​セットアップ

​はじめに: APIキーから最初のセッションまで

​ステップ 1: 認証情報を確認する

​ステップ 2: 自分の組織を一覧表示する

​ステップ 3: セッションを作成する

​ステップ 4: イベントをポーリングする

​Pythonの完全な例

​セッションの添付ファイルをダウンロード

​ステップ 1: セッションを取得する

​ステップ 2: 添付ファイルを一覧表示する

​ステップ 3: ダウンロード

​Pythonの完全な使用例

​Knowledge と playbook の管理

​Knowledgeノートを作成する

​Knowledgeノートを一覧表示する

​Knowledgeノートを更新する

​Knowledgeノートを削除する

​playbook を作成する

​Pythonの完全な例

​自動セッションのスケジュール設定

​スケジュールを作成する

​スケジュールを一覧表示する

​スケジュールを更新する

​スケジュールを削除する

​Pythonの完全な例

​エラー処理

​サポート

お困りですか？

セットアップ

はじめに: APIキーから最初のセッションまで

ステップ 1: 認証情報を確認する

ステップ 2: 自分の組織を一覧表示する

ステップ 3: セッションを作成する

ステップ 4: イベントをポーリングする

Pythonの完全な例

セッションの添付ファイルをダウンロード

ステップ 1: セッションを取得する

ステップ 2: 添付ファイルを一覧表示する

ステップ 3: ダウンロード

Pythonの完全な使用例

Knowledge と playbook の管理

Knowledgeノートを作成する

Knowledgeノートを一覧表示する

Knowledgeノートを更新する

Knowledgeノートを削除する

playbook を作成する

Pythonの完全な例

自動セッションのスケジュール設定

スケジュールを作成する

スケジュールを一覧表示する

スケジュールを更新する

スケジュールを削除する

Pythonの完全な例

エラー処理

サポート