AGI01
AGI01

项目管理

接口概述

项目管理接口用于创建和管理项目，包括项目设置、成员管理、资源配置等功能。

基本信息

  • 接口路径：/v1/organizations/{organization_id}/projects
  • 需要认证：是
  • 请求方式：GET/POST/PUT/DELETE
  • 数据格式：JSON

API 接口

创建项目

请求

POST /v1/organizations/{organization_id}/projects
Authorization: Bearer your-api-key
Content-Type: application/json

{
    "name": "我的项目",
    "description": "项目描述",
    "settings": {
        "model": "zgi-1",
        "max_tokens": 4096,
        "temperature": 0.7
    },
    "visibility": "private"
}

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "id": "proj_def456",
        "name": "我的项目",
        "description": "项目描述",
        "created_at": "2024-02-01T10:00:00Z",
        "updated_at": "2024-02-01T10:00:00Z",
        "settings": {
            "model": "zgi-1",
            "max_tokens": 4096,
            "temperature": 0.7
        },
        "visibility": "private",
        "organization_id": "org_abc123"
    }
}

获取项目列表

请求

GET /v1/organizations/{organization_id}/projects
Authorization: Bearer your-api-key

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "projects": [
            {
                "id": "proj_def456",
                "name": "我的项目",
                "description": "项目描述",
                "created_at": "2024-02-01T10:00:00Z",
                "updated_at": "2024-02-01T10:00:00Z",
                "visibility": "private",
                "role": "owner"
            }
        ],
        "total": 1,
        "page": 1,
        "page_size": 10
    }
}

获取项目详情

请求

GET /v1/organizations/{organization_id}/projects/{project_id}
Authorization: Bearer your-api-key

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "id": "proj_def456",
        "name": "我的项目",
        "description": "项目描述",
        "created_at": "2024-02-01T10:00:00Z",
        "updated_at": "2024-02-01T10:00:00Z",
        "settings": {
            "model": "zgi-1",
            "max_tokens": 4096,
            "temperature": 0.7
        },
        "visibility": "private",
        "organization_id": "org_abc123",
        "members_count": 3,
        "api_keys_count": 2,
        "usage": {
            "tokens": 1000,
            "requests": 100
        }
    }
}

更新项目信息

请求

PUT /v1/organizations/{organization_id}/projects/{project_id}
Authorization: Bearer your-api-key
Content-Type: application/json

{
    "name": "新项目名称",
    "description": "新项目描述",
    "settings": {
        "model": "zgi-1-pro",
        "max_tokens": 8192,
        "temperature": 0.5
    }
}

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "id": "proj_def456",
        "name": "新项目名称",
        "description": "新项目描述",
        "updated_at": "2024-02-01T11:00:00Z",
        "settings": {
            "model": "zgi-1-pro",
            "max_tokens": 8192,
            "temperature": 0.5
        }
    }
}

删除项目

请求

DELETE /v1/organizations/{organization_id}/projects/{project_id}
Authorization: Bearer your-api-key

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "message": "项目已删除"
    }
}

添加项目成员

请求

POST /v1/organizations/{organization_id}/projects/{project_id}/members
Authorization: Bearer your-api-key
Content-Type: application/json

{
    "user_id": "user_456",
    "role": "developer"
}

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "id": "user_456",
        "email": "developer@example.com",
        "username": "developer",
        "role": "developer",
        "added_at": "2024-02-01T10:00:00Z"
    }
}

获取项目成员列表

请求

GET /v1/organizations/{organization_id}/projects/{project_id}/members
Authorization: Bearer your-api-key

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "members": [
            {
                "id": "user_123",
                "email": "user@example.com",
                "username": "username",
                "role": "owner",
                "joined_at": "2024-02-01T10:00:00Z"
            }
        ],
        "total": 1,
        "page": 1,
        "page_size": 10
    }
}

更新项目成员角色

请求

PUT /v1/organizations/{organization_id}/projects/{project_id}/members/{member_id}
Authorization: Bearer your-api-key
Content-Type: application/json

{
    "role": "admin"
}

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "id": "user_456",
        "email": "developer@example.com",
        "username": "developer",
        "role": "admin",
        "updated_at": "2024-02-01T11:00:00Z"
    }
}

移除项目成员

请求

DELETE /v1/organizations/{organization_id}/projects/{project_id}/members/{member_id}
Authorization: Bearer your-api-key

响应

{
    "status_code": 200,
    "status_message": "SUCCESS",
    "data": {
        "message": "成员已移除"
    }
}

错误码

错误码 说明 解决方案
400 请求参数错误 检查请求参数是否符合要求
401 未授权 检查 API 密钥是否有效
403 权限不足 检查用户是否有相应的操作权限
404 项目不存在 检查项目 ID 是否正确
409 资源冲突 检查是否存在命名冲突等问题

权限说明

角色类型

  • owner: 项目所有者
  • admin: 管理员
  • developer: 开发者
  • viewer: 查看者

权限矩阵

操作 owner admin developer viewer
查看项目信息 ✓ ✓ ✓ ✓
修改项目信息 ✓ ✓ × ×
删除项目 ✓ × × ×
管理成员 ✓ ✓ × ×
查看成员列表 ✓ ✓ ✓ ✓
管理 API 密钥 ✓ ✓ × ×
查看使用统计 ✓ ✓ ✓ ✓

使用建议

1. 项目创建

  • 设置合适的项目可见性
  • 选择适当的模型和参数
  • 规划成员角色和权限

2. 资源管理

  • 监控 API 使用情况
  • 及时调整资源配置
  • 控制成本支出

3. 安全建议

  • 定期审查成员权限
  • 及时撤销离职成员权限
  • 监控异常访问行为