> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 使用示例

> Devin API 的代码示例和常见用例

本页提供常见 API 用例的代码示例。所有示例都使用环境变量来存储凭据——只需设置一次，之后每个示例即可直接复制粘贴使用。有关完整的请求/响应模式，请参阅各个端点的 API 参考页面。

## 设置

在运行任何示例之前，请先设置这些环境变量：

```bash theme={null}
# 必填：您的服务用户 API 密钥或个人访问令牌（以 cog_ 开头）
export DEVIN_API_KEY="cog_your_key_here"

# 必填：您的组织 ID（显示在设置 → Devin API 页面顶部）
export DEVIN_ORG_ID="your_org_id"
```

> [!TIP]
>
> 在 **设置 → Devin API** 页面顶部查找您的组织 ID。

## curl 示例

按照上面的说明设置好环境变量后，你可以在终端中直接运行这些示例。

> **创建会话**
>
> ```bash theme={null}
> 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"}'
> ```

> **列出会话**
>
> ```bash theme={null}
> curl "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions" \
>   -H "Authorization: Bearer $DEVIN_API_KEY"
> ```

> **向会话发送消息**
>
> ```bash theme={null}
> export SESSION_ID="your_session_id"
>
> curl -X POST "https://api.devin.ai/v3/organizations/$DEVIN_ORG_ID/sessions/$SESSION_ID/messages" \
>   -H "Authorization: Bearer $DEVIN_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"message": "Please also add unit tests"}'
> ```

> **创建 Knowledge 笔记**
>
> ```bash theme={null}
> 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 this repo",
>     "body": "Use TypeScript strict mode. Follow the existing code style."
>   }'
> ```

> **列出企业组织**
>
> ```bash theme={null}
> curl "https://api.devin.ai/v3/enterprise/organizations" \
>   -H "Authorization: Bearer $DEVIN_API_KEY"
> ```

> **获取使用量数据**
>
> ```bash theme={null}
> # 使用 Unix 时间戳 — 示例：2025 年 1 月 1 日到 1 月 31 日
> curl "https://api.devin.ai/v3/enterprise/consumption/daily?time_after=1735689600&time_before=1738368000" \
>   -H "Authorization: Bearer $DEVIN_API_KEY"
> ```

## Python 示例

> **创建会话**
>
> ```python theme={null}
> import os
> import requests
>
> API_KEY = os.environ["DEVIN_API_KEY"]
> ORG_ID = os.environ["DEVIN_ORG_ID"]
> BASE_URL = "https://api.devin.ai/v3"
>
> response = requests.post(
>     f"{BASE_URL}/organizations/{ORG_ID}/sessions",
>     headers={
>         "Authorization": f"Bearer {API_KEY}",
>         "Content-Type": "application/json"
>     },
>     json={
>         "prompt": "Create a Python script that analyzes CSV data"
>     }
> )
> response.raise_for_status()
>
> session = response.json()
> print(f"Session created: {session['session_id']}")
> print(f"URL: {session['url']}")
> ```

> **轮询会话状态**
>
> ```python theme={null}
> import os
> import time
> import requests
>
> API_KEY = os.environ["DEVIN_API_KEY"]
> ORG_ID = os.environ["DEVIN_ORG_ID"]
> BASE_URL = "https://api.devin.ai/v3"
> SESSION_ID = os.environ.get("SESSION_ID", "your_session_id")
>
> while True:
>     response = requests.get(
>         f"{BASE_URL}/organizations/{ORG_ID}/sessions/{SESSION_ID}",
>         headers={"Authorization": f"Bearer {API_KEY}"}
>     )
>     response.raise_for_status()
>     session = response.json()
>
>     status = session["status"]
>     print(f"Status: {status}")
>
>     # 终止状态："exit"（已完成）、"error"、"suspended"
>     if status in ("exit", "error", "suspended"):
>         break
>
>     time.sleep(10)
> ```

> **多组织工作流（Enterprise）**
>
> 跨多个组织实现自动化：
>
> ```python theme={null}
> import os
> import requests
>
> API_KEY = os.environ["DEVIN_API_KEY"]
> BASE_URL = "https://api.devin.ai/v3"
>
> # 获取所有组织
> orgs_response = requests.get(
>     f"{BASE_URL}/enterprise/organizations",
>     headers={"Authorization": f"Bearer {API_KEY}"}
> )
> orgs_response.raise_for_status()
> organizations = orgs_response.json()["items"]
>
> # 在每个组织中创建会话
> for org in organizations:
>     session_response = requests.post(
>         f"{BASE_URL}/organizations/{org['org_id']}/sessions",
>         headers={
>             "Authorization": f"Bearer {API_KEY}",
>             "Content-Type": "application/json"
>         },
>         json={
>             "prompt": f"Run daily health check for {org['name']}"
>         }
>     )
>
>     if session_response.ok:
>         session = session_response.json()
>         print(f"Created session for {org['name']}: {session['session_id']}")
>     else:
>         print(f"Failed for {org['name']}: {session_response.status_code}")
> ```

> **分页获取审计日志（企业版）**
>
> ```python theme={null}
> import os
> import requests
> from datetime import datetime, timedelta, timezone
>
> API_KEY = os.environ["DEVIN_API_KEY"]
> BASE_URL = "https://api.devin.ai/v3"
>
> # 最近 7 天的 Unix 时间戳
> now = datetime.now(timezone.utc)
> seven_days_ago = now - timedelta(days=7)
>
> params = {
>     "time_after": int(seven_days_ago.timestamp()),
>     "time_before": int(now.timestamp()),
>     "first": 100,
> }
>
> all_logs = []
> while True:
>     response = requests.get(
>         f"{BASE_URL}/enterprise/audit-logs",
>         headers={"Authorization": f"Bearer {API_KEY}"},
>         params=params,
>     )
>     response.raise_for_status()
>     data = response.json()
>
>     all_logs.extend(data["items"])
>     print(f"Fetched {len(data['items'])} logs (total: {len(all_logs)})")
>
>     if not data.get("has_next_page"):
>         break
>     params["after"] = data["end_cursor"]
>
> for log in all_logs:
>     ts = datetime.fromtimestamp(log["created_at"], tz=timezone.utc).isoformat()
>     actor = log.get("service_user_id") or log.get("user_id") or "system"
>     print(f"{ts} - {log['action']} (actor={actor})")
> ```

> **错误处理**
>
> ```python theme={null}
> import os
> import requests
>
> API_KEY = os.environ["DEVIN_API_KEY"]
> ORG_ID = os.environ["DEVIN_ORG_ID"]
> BASE_URL = "https://api.devin.ai/v3"
>
> try:
>     response = requests.get(
>         f"{BASE_URL}/organizations/{ORG_ID}/sessions",
>         headers={"Authorization": f"Bearer {API_KEY}"}
>     )
>     response.raise_for_status()
>     data = response.json()
> except requests.exceptions.HTTPError as e:
>     if e.response.status_code == 401:
>         print("API key rejected — it may be expired or revoked")
>     elif e.response.status_code == 403:
>         # 403 既可能表示 API 密钥无法识别，也可能表示密钥有效
>         # 但缺少所需权限，因此需要同时检查这两种情况。
>         print("Forbidden — verify DEVIN_API_KEY is correct and that "
>               "the caller has the required permission")
>     elif e.response.status_code == 429:
>         print("Rate limit exceeded — wait and retry")
>     else:
>         print(f"API error: {e.response.status_code} {e.response.text}")
> ```

## 支持

> **需要帮助？**
>
> 如果您对 API 有任何疑问或需要报告问题，请发送邮件至 [support@cognition.ai](mailto:support@cognition.ai)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.