DP Technology (Bohrium) 项目管理 (bohrium-project) API

项目管理 — 创建项目、管理成员、设置额度。免费(管理成本额度,非按调用计费)。

OpenAPI Specification

dp-bohrium-project-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Bohrium Open AI 科学小导师 (bohrium-mentor) AI 科学小导师 (bohrium-mentor) 项目管理 (bohrium-project) API
  description: 'Bohrium 平台对外 OpenAPI 的单一事实源(single source of truth)。


    本文档由仓库 `dptech-corp/bohrium-skills` 的 `docs/api/openapi.json` 维护,内容基于各 Skill(`zh/<skill>/SKILL.md`)中记录的真实接口生成;Apifox 定时从本仓库抓取并同步到 https://open.bohrium.com 。


    鉴权:所有接口使用 `Authorization: Bearer <BOHR_ACCESS_KEY>`。业务返回通常为 `{code, data, message}` 信封,`code==0` 成功,`code==2000` 未授权。


    计费端点在 operation 上以 `x-bohrium-price` 扩展标注机器可读价格,并在 description 末尾追加人类可读的「计费」行。


    说明:`bohrium-database`(SDK/CLI)与 `bohrium-sandbox`(CLI)不直接暴露 REST 端点,故本文档未收录其路径。'
  version: 2.0.0
servers:
- url: https://open.bohrium.com
  description: Bohrium OpenAPI 正式环境
security:
- bearerAuth: []
tags:
- name: 项目管理 (bohrium-project)
  description: 项目管理 — 创建项目、管理成员、设置额度。免费(管理成本额度,非按调用计费)。
paths:
  /openapi/v2/project/list:
    get:
      tags:
      - 项目管理 (bohrium-project)
      summary: 详细项目列表
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/lite_list:
    get:
      tags:
      - 项目管理 (bohrium-project)
      summary: 精简列表(id+name)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/set_name:
    post:
      tags:
      - 项目管理 (bohrium-project)
      summary: 重命名项目
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                name:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/set_cost_limit:
    post:
      tags:
      - 项目管理 (bohrium-project)
      summary: 设置成本上限
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                costLimit:
                  type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/{id}/users:
    get:
      tags:
      - 项目管理 (bohrium-project)
      summary: 项目成员
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/add_user:
    post:
      tags:
      - 项目管理 (bohrium-project)
      summary: 添加成员
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                email:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/del_user:
    post:
      tags:
      - 项目管理 (bohrium-project)
      summary: 移除成员
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                userId:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/manager/add:
    post:
      tags:
      - 项目管理 (bohrium-project)
      summary: 添加管理员
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                userId:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/manager/del:
    post:
      tags:
      - 项目管理 (bohrium-project)
      summary: 移除管理员
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                userId:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /openapi/v2/project/{id}/recovery_user:
    put:
      tags:
      - 项目管理 (bohrium-project)
      summary: 恢复被移除成员
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          description: 0 成功,2000 未授权
        message:
          type: string
        data:
          type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bohrium AccessKey,环境变量 BOHR_ACCESS_KEY,作为 Bearer token