searchpipe-tech Dashboard API

openapi: 3.2.0
info:
  title: SearchPipe Dashboard API
  version: 0.2.0
tags:
- name: Dashboard
paths:
  /dashboard/auth:
    get:
      tags:
      - Dashboard
      summary: Auth Landing
      description: OAuth/JWT 登录落地：token（JWT access）→ 校验 → 设 session cookie → /dashboard。
      operationId: auth_landing_dashboard_auth_get
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/bonus-flash:
    get:
      tags:
      - Dashboard
      summary: Bonus Flash
      description: '每月免费额度弹窗数据（**读取一次即消费**，同一笔发放只提醒一次）。


        控制台页面（base.html）加载时拉取，命中则弹窗提示「+N 积分已到账、X 月 X 日到期」。

        没有待提醒内容返回 {"bonus": null}；未登录 401。'
      operationId: bonus_flash_dashboard_bonus_flash_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Bonus Flash Dashboard Bonus Flash Get
  /dashboard/login:
    get:
      tags:
      - Dashboard
      summary: Login Page
      description: '登录页（仅邮箱密码）。支持多种提示：

        - ?reset=1 密码已重置

        - ?registered=1 注册成功，请查收验证邮件

        - ?verify_success=1 邮箱验证成功

        - ?verify_error=1 验证链接无效或已过期

        - ?verify_already=1 邮箱已验证

        - ?next= 登录后回跳


        已登录（有效会话）访问登录页 → 303 回 /dashboard（安全 next 优先）：

        页头右上角对匿名/登录态统一展示 Log in（2026-10-30），已登录用户点进去

        不能落在空登录表单。带提示参数（registered/reset/verify_*）时不跳转——

        注册即登录，?registered=1 的查收验证邮件提示必须在已登录态下可见。

        必须查库确认用户仍有效——失效 cookie 直接放行渲染登录页，否则与控制台

        守卫互相 303 成死循环。'
      operationId: login_page_dashboard_login_get
      parameters:
      - name: reset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Reset
      - name: registered
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Registered
      - name: verify_success
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Verify Success
      - name: verify_error
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Verify Error
      - name: verify_already
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Verify Already
      - name: next
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Next
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Login Page Dashboard Login Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Dashboard
      summary: Login Submit
      description: '邮箱密码登录 → 设 cookie → next（站内）或 /dashboard。失败重渲染登录页并提示。


        控制台面向真实用户，显式区分「邮箱未注册」与「密码错误」；

        API 层（/auth/login）仍返回统一 401 防脚本枚举。'
      operationId: login_submit_dashboard_login_post
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_login_submit_dashboard_login_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Login Submit Dashboard Login Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/register:
    get:
      tags:
      - Dashboard
      summary: Register Page
      description: 注册页（仅邮箱密码）。?next= 注册后回跳；?code= 预填邀请码。
      operationId: register_page_dashboard_register_get
      parameters:
      - name: next
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Next
      - name: code
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Register Page Dashboard Register Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Dashboard
      summary: Register Submit
      description: '邮箱注册 → 送免费额度 → 设 cookie → next（站内）或 /dashboard。失败重渲染注册页并提示。


        支持邀请码：填写有效邀请码时，邀请方和被邀请方各获得永久积分奖励。'
      operationId: register_submit_dashboard_register_post
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_register_submit_dashboard_register_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Register Submit Dashboard Register Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/forgot-password:
    get:
      tags:
      - Dashboard
      summary: Forgot Password Page
      description: 忘记密码页。
      operationId: forgot_password_page_dashboard_forgot_password_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Forgot Password Page Dashboard Forgot Password Get
    post:
      tags:
      - Dashboard
      summary: Forgot Password Submit
      description: 发重置邮件。无论邮箱是否注册都展示同一话术（防枚举）。
      operationId: forgot_password_submit_dashboard_forgot_password_post
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_forgot_password_submit_dashboard_forgot_password_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Forgot Password Submit Dashboard Forgot Password Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/reset-password:
    get:
      tags:
      - Dashboard
      summary: Reset Password Page
      description: 重置密码页：预检 token 有效性，无效直接提示链接失效。
      operationId: reset_password_page_dashboard_reset_password_get
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Reset Password Page Dashboard Reset Password Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Dashboard
      summary: Reset Password Submit
      description: 校验 token 改密 → 302 登录页（带重置成功提示）。
      operationId: reset_password_submit_dashboard_reset_password_post
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_reset_password_submit_dashboard_reset_password_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Reset Password Submit Dashboard Reset Password Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/resend-verification:
    post:
      tags:
      - Dashboard
      summary: Resend Verification
      description: 重发验证邮件（需登录）。
      operationId: resend_verification_dashboard_resend_verification_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Resend Verification Dashboard Resend Verification Post
  /dashboard/logout:
    get:
      tags:
      - Dashboard
      summary: Logout
      operationId: logout_dashboard_logout_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /dashboard/:
    get:
      tags:
      - Dashboard
      summary: Dashboard Home
      description: '主面板：余额 + 用量曲线 + 快速搜索。


        ?q=xxx：预填快速搜索框并自动触发（落地页「在线体验」入口）。

        未登录时把 /dashboard?q=xxx 整体作为 next 带去登录页，登录后回跳不丢 query。

        ?resend_success=1：重发验证邮件成功提示。

        ?resend_cooldown=1：重发验证邮件冷却期提示。'
      operationId: dashboard_home_dashboard__get
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Q
      - name: resend_success
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Resend Success
      - name: resend_cooldown
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Resend Cooldown
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Home Dashboard  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard:
    get:
      tags:
      - Dashboard
      summary: Dashboard Home
      description: '主面板：余额 + 用量曲线 + 快速搜索。


        ?q=xxx：预填快速搜索框并自动触发（落地页「在线体验」入口）。

        未登录时把 /dashboard?q=xxx 整体作为 next 带去登录页，登录后回跳不丢 query。

        ?resend_success=1：重发验证邮件成功提示。

        ?resend_cooldown=1：重发验证邮件冷却期提示。'
      operationId: dashboard_home_dashboard_get
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Q
      - name: resend_success
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Resend Success
      - name: resend_cooldown
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Resend Cooldown
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Home Dashboard Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/api-keys:
    get:
      tags:
      - Dashboard
      summary: Dashboard Api Keys
      description: API Keys 管理页：Key 列表（可点击查看明文）+ MCP 配置卡片（选 Key 生成链接）。
      operationId: dashboard_api_keys_dashboard_api_keys_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Api Keys Dashboard Api Keys Get
  /dashboard/usage:
    get:
      tags:
      - Dashboard
      summary: Dashboard Usage
      description: '用量页：图表与明细由浏览器 JS 调 /usage、/usage/logs 拉取。


        积分明细（永久/限时/未生效批次）与交易流水从 billing 页迁来，服务端渲染：

        用量消耗与积分账本同页可查，billing 页专注充值/订阅/订单。'
      operationId: dashboard_usage_dashboard_usage_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Usage Dashboard Usage Get
  /dashboard/billing:
    get:
      tags:
      - Dashboard
      summary: Dashboard Billing
      description: '充值/订阅/订单页：余额卡（永久/限时构成）+ 套餐 + 充值 + 订单中心。


        积分明细批次卡与交易流水已迁到 /dashboard/usage，这里只留余额汇总。

        等待页终态跳回承接：?paid= 渲染成功横幅（入账积分），

        ?pay_closed= 渲染关闭横幅（收银台未完成支付即关）。仅本人订单

        生效（他人/不存在/非法值一律静默不渲染），前端读后即清 URL 参数，刷新不复现。'
      operationId: dashboard_billing_dashboard_billing_get
      parameters:
      - name: paid
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Paid
      - name: pay_closed
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Pay Closed
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Billing Dashboard Billing Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/docs:
    get:
      tags:
      - Dashboard
      summary: Dashboard Docs
      description: '开发文档已改为公开页面（可被搜索引擎收录）。


        这里做 301 永久跳转：老的站内链接、用户书签与已收录 URL 都能落到 /docs，

        同时避免同一份文档出现两个 URL 造成重复内容。'
      operationId: dashboard_docs_dashboard_docs_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /dashboard/feedback:
    get:
      tags:
      - Dashboard
      summary: Dashboard Feedback
      description: '反馈工单页：提交表单 + 我的工单列表。


        预填参数（支付失败入口专用）：?category=billing&order=——

        category 白名单外的值忽略（回退 other）；order 仅作预填展示与提交回传，

        归属校验在 POST /feedback 侧完成（这里不查库，拉取订单上下文由前端

        GET /payments/orders/{id} 完成，非本人自然 404 静默降级）。'
      operationId: dashboard_feedback_dashboard_feedback_get
      parameters:
      - name: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Category
      - name: order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Order
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Feedback Dashboard Feedback Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dashboard/messages:
    get:
      tags:
      - Dashboard
      summary: Dashboard Messages
      description: 站内信页：消息列表 + 未读高亮 + 点开标记已读（数据由 JS 调 /messages 拉取）。
      operationId: dashboard_messages_dashboard_messages_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Dashboard Messages Dashboard Messages Get
components:
  schemas:
    Body_register_submit_dashboard_register_post:
      properties:
        email:
          type: string
          title: Email
        password:
          type: string
          title: Password
        password_confirm:
          type: string
          title: Password Confirm
        agree_terms:
          type: string
          title: Agree Terms
          default: ''
        next:
          type: string
          title: Next
          default: ''
        invitation_code:
          type: string
          title: Invitation Code
          default: ''
      type: object
      required:
      - email
      - password
      - password_confirm
      title: Body_register_submit_dashboard_register_post
    Body_forgot_password_submit_dashboard_forgot_password_post:
      properties:
        email:
          type: string
          title: Email
      type: object
      required:
      - email
      title: Body_forgot_password_submit_dashboard_forgot_password_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_login_submit_dashboard_login_post:
      properties:
        email:
          type: string
          title: Email
        password:
          type: string
          title: Password
        agree_terms:
          type: string
          title: Agree Terms
          default: ''
        next:
          type: string
          title: Next
          default: ''
      type: object
      required:
      - email
      - password
      title: Body_login_submit_dashboard_login_post
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Body_reset_password_submit_dashboard_reset_password_post:
      properties:
        token:
          type: string
          title: Token
        password:
          type: string
          title: Password
        password_confirm:
          type: string
          title: Password Confirm
      type: object
      required:
      - token
      - password
      - password_confirm
      title: Body_reset_password_submit_dashboard_reset_password_post
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer