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

# 开始平台授权

> 接口说明：生成平台 OAuth 授权 URL



## OpenAPI

````yaml /openapi/zh/aitoearn.openapi.json get /api/v2/channels/accounts/auth/{platform}
openapi: 3.0.1
info:
  title: AiToEarn 开放平台 API
  description: AiToEarn 开放平台 API，支持在中国站与国际站之间切换调试。业务是否成功以响应体 code === 0 为准。
  version: 1.0.0
  contact: {}
servers:
  - url: https://aitoearn.cn
    description: 中国站
  - url: https://aitoearn.ai
    description: 国际站
security: []
tags:
  - name: AI 服务
  - name: AI 服务/视频生成
  - name: AI 服务/图像生成
  - name: AI 服务/模型中转
  - name: 渠道管理
  - name: 渠道管理/账号
  - name: 渠道管理/内容发布
  - name: 渠道管理/平台
  - name: 渠道管理/互动
  - name: 渠道管理/作品
  - name: 渠道管理/账号分组
  - name: 渠道管理/授权
  - name: 资源管理
paths:
  /api/v2/channels/accounts/auth/{platform}:
    get:
      tags:
        - 渠道管理/授权
      summary: 开始平台授权
      description: 接口说明：生成平台 OAuth 授权 URL
      operationId: AuthController_startAuth_v2
      parameters:
        - name: platform
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: callbackUrl
          in: query
          description: 授权完成后浏览器 POST relay 的回调地址
          required: false
          example: ''
          schema:
            description: 授权完成后浏览器 POST relay 的回调地址
            type: string
            format: uri
        - name: redirectUri
          in: query
          description: 授权完成后浏览器跳转地址
          required: false
          example: ''
          schema:
            description: 授权完成后浏览器跳转地址
            type: string
            format: uri
        - name: groupId
          in: query
          description: 账号组 ID，不传则使用默认组
          required: false
          example: ''
          schema:
            description: 账号组 ID，不传则使用默认组
            type: string
      responses:
        '200':
          description: 请求已被服务处理。业务是否成功以响应体 code === 0 为准。
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AuthStartVo'
                  code:
                    type: integer
                    description: 业务状态码。0 表示成功，非 0 表示业务错误。
                  message:
                    type: string
                    description: 响应消息。
                  requestId:
                    type: string
                    description: 请求 ID。
                  timestamp:
                    type: integer
                    description: 错误响应时间戳，Unix 毫秒。
                required:
                  - code
                  - message
              examples:
                success:
                  summary: 成功
                  value:
                    code: 0
                    message: 请求成功
                    data:
                      url: string
                      sessionId: string
                      expiresAt: '2026-07-02T12:00:00.000Z'
                      authInstructions:
                        en-US: string
                        zh-CN: string
                validationFailed10002:
                  summary: ValidationFailed (10002)
                  value:
                    code: 10002
                    message: 参数验证失败
                    data: {}
                    timestamp: 1772099056662
                unauthorized401:
                  summary: 未认证或 API Key 无效
                  value:
                    code: 401
                    message: Unauthorized
                    data: {}
                    timestamp: 1772099056662
      deprecated: false
      security:
        - apikey-header-X-Api-Key: []
components:
  schemas:
    AuthStartVo:
      type: object
      properties:
        url:
          type: string
          description: 平台授权 URL 或二维码图片 data URL
        sessionId:
          type: string
          description: 授权 Session ID
        expiresAt:
          description: 授权 Session 过期时间
          type: string
          format: date-time
        authInstructions:
          description: 授权操作提示语
          type: object
          properties:
            en-US:
              type: string
              description: 英文文案
            zh-CN:
              type: string
              description: 中文文案
          required:
            - en-US
            - zh-CN
          additionalProperties: false
      required:
        - url
        - sessionId
        - expiresAt
      additionalProperties: false
  securitySchemes:
    apikey-header-X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key
      description: AiToEarn Open Platform API Key。

````