api_endpoints

# Benchling REST API 端点参考 ## 基础 URL 所有 API 请求均使用以下基础 URL 格式： https://{tenant}.benchling.com/api/v2 将 `{tenant}` 替换为您的 Benchling 租户名称。 ## API 版本控制 当前 API 版本：`v2` (2025-10-07) API 版本在 URL 路径中指定。Benchling 在主版本内保持向后兼容。 ## 认证 所有请求均需通过 HTTP 标头进行认证： **API 密钥 (Basic Auth)：** bash curl -X GET https://your-tenant.benchling.com/api/v2/dna-sequences -u "your_api_key:" **OAuth Bearer 令牌：** bash curl -X GET https://your-tenant.benchling.com/api/v2/dna-sequences -H "Authorization: Bearer your_access_token" ## 通用标头 Authorization: Bearer {token} Content-Type: application/json Accept: application/json ## 响应格式 所有响应均遵循一致的 JSON 结构： **单个资源：** { "id": "seq_abc123", "name": "My Sequence", "bases": "ATCGATCG", ... } **列表响应：** { "results": [ {"id": "seq_1", "name": "Sequence 1"}, {"id": "seq_2", "name": "Sequence 2"} ], "nextToken": "token_for_next_page" } ## 分页 列表端点支持分页： **查询参数：** - `pageSize`: 每页项目数（默认：50，最大：100） - `nextToken`: 来自上一个响应的令牌，用于获取下一页 **示例：** bash curl -X GET "https://your-tenant.benchling.com/api/v2/dna-sequences?pageSize=50&nextToken=abc123" ## 错误响应 **格式：** { "error": { "type": "NotFoundError", "message": "DNA sequence not found", "userMessage": "The requested sequence does not exist or you don't have access" } } **常见状态码：** - `200 OK`: 成功 - `201 Created`: 资源已创建 - `400 Bad Request`: 参数无效 - `401 Unauthorized`: 凭据缺失或无效 - `403 Forbidden`: 权限不足 - `404 Not Found`: 资源不存在 - `422 Unprocessable Entity`: 验证错误 - `429 Too Many Requests`: 超出速率限制 - `500 Internal Server Error`: 服务器错误 ## 核心端点 ### DNA 序列 **列出 DNA 序列：** http GET /api/v2/dna-sequences Query Parameters: - pageSize: integer (default: 50, max: 100) - nextToken: string - folderId: string - schemaId: string - name: string (filter by name) - modifiedAt: string (ISO 8601 date) **获取 DNA 序列：** http GET /api/v2/dna-sequences/{s