> ## 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.

# Platform List

> Interface description: Returns the metadata list of registered platforms, including display name, logo, capability statement, etc.



## OpenAPI

````yaml /openapi/en/aitoearn.openapi.json get /api/v2/channels/platforms
openapi: 3.0.1
info:
  title: AiToEarn Open Platform API
  description: >-
    AiToEarn Open Platform API. You can switch between the China and
    international sites for testing. Business success is determined by whether
    the response body has code === 0.
  version: 1.0.0
  contact: {}
servers:
  - url: https://aitoearn.cn
    description: China site
  - url: https://aitoearn.ai
    description: International site
security: []
tags:
  - name: AI Services
  - name: AI Services/Video Generation
  - name: AI Services/Image Generation
  - name: Channel Management
  - name: Channel Management/Accounts
  - name: Channel Management/Publishing
  - name: Channel Management/Platforms
  - name: Channel Management/Works
  - name: Channel Management/Account Groups
  - name: Channel Management/Authorization
  - name: Asset Management
  - name: AI Services/Large Language Models
paths:
  /api/v2/channels/platforms:
    get:
      tags:
        - Channel Management/Platforms
      summary: Platform List
      description: >-
        Interface description: Returns the metadata list of registered
        platforms, including display name, logo, capability statement, etc.
      operationId: PlatformsController_listPlatforms_v2
      parameters: []
      responses:
        '200':
          description: >-
            The request has been processed by the service. Business success is
            determined by whether the response body has code === 0.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PlatformMetadataVo'
                  code:
                    type: integer
                    description: >-
                      Business status code. 0 means success; non-zero means a
                      business error.
                  message:
                    type: string
                    description: Response message.
                  requestId:
                    type: string
                    description: Request ID.
                  timestamp:
                    type: integer
                    description: Error response timestamp in Unix milliseconds.
                required:
                  - code
                  - message
              examples:
                success:
                  summary: Success
                  value:
                    code: 0
                    message: Request succeeded
                    data:
                      - platform: douyin
                        displayName:
                          en-US: string
                          zh-CN: string
                        logoUrl: https://assets.aitoearn.cn/example.png
                        authType: oauth2
                        editor: none
                        contentLimits:
                          modes:
                            - article2
                          maxTitleLength: 1
                          maxBodyLength: 1
                          maxTotalTextLength: 1
                          maxMediaCount: 1
                          maxImages: 1
                          maxVideos: 1
                        mediaRules:
                          imageFormats:
                            - string
                          videoFormats:
                            - string
                          maxImageSize: 1
                          maxVideoSize: 1
                          minVideoDuration: 1
                          maxVideoDuration: 1
                          minImageWidth: 1
                          minImageHeight: 1
                          maxImageWidth: 1
                          maxImageHeight: 1
                          aspectRatio:
                            min: 1
                            max: 1
                        topic:
                          supported: true
                          nativeField: true
                          maxCount: 1
                          maxTotalLength: 1
                        capabilities:
                          auth:
                            supported: true
                            revoke: true
                            selectableAccounts: true
                            refreshAccountAccess: true
                          publish:
                            supported: true
                            cancel: true
                            update: true
                            verify: true
                            finalize: true
                            scheduleByPlatform: true
                            optionSources: true
                            completionStrategy: sync
                          analytics:
                            account: true
                            work: true
                          engagement:
                            comments:
                              list: {}
                              create: {}
                            functions:
                              - {}
                          work:
                            listWorks: true
                            listWorksPagination: {}
                            getLinkInfo: true
                            getDetail: true
                            verifyOwnership: true
                          browse:
                            search: true
                            getDetail: true
                          webhook:
                            supported: true
                        optionSchema: {}
                        status: hidden
                        authInstructions:
                          en-US: string
                          zh-CN: string
      deprecated: false
      security: []
components:
  schemas:
    PlatformMetadataVo:
      type: object
      properties:
        platform:
          type: string
          enum:
            - douyin
            - xhs
            - wxSph
            - KWAI
            - youtube
            - wxGzh
            - bilibili
            - twitter
            - tiktok
            - facebook
            - instagram
            - threads
            - pinterest
            - linkedin
            - google_business
          description: platform
        displayName:
          type: object
          properties:
            en-US:
              type: string
              description: English copywriting
            zh-CN:
              type: string
              description: Chinese copywriting
          required:
            - en-US
            - zh-CN
          additionalProperties: false
          description: display name
        logoUrl:
          type: string
          format: uri
          description: Platform logo URL
        authType:
          type: string
          enum:
            - oauth2
            - browser
            - plugin
            - qrcode
          description: Authorization type
        authInstructions:
          description: Authorization operation prompts
          type: object
          properties:
            en-US:
              type: string
              description: English copywriting
            zh-CN:
              type: string
              description: Chinese copywriting
          required:
            - en-US
            - zh-CN
          additionalProperties: false
        emptyAccountHint:
          description: Empty account guidance prompt
          type: object
          properties:
            title:
              type: object
              properties:
                en-US:
                  type: string
                  description: English copywriting
                zh-CN:
                  type: string
                  description: Chinese copywriting
              required:
                - en-US
                - zh-CN
              additionalProperties: false
              description: Empty account prompt title
            description:
              type: object
              properties:
                en-US:
                  type: string
                  description: English copywriting
                zh-CN:
                  type: string
                  description: Chinese copywriting
              required:
                - en-US
                - zh-CN
              additionalProperties: false
              description: Empty account prompt description
            action:
              description: Action button
              type: object
              properties:
                label:
                  type: object
                  properties:
                    en-US:
                      type: string
                      description: English copywriting
                    zh-CN:
                      type: string
                      description: Chinese copywriting
                  required:
                    - en-US
                    - zh-CN
                  additionalProperties: false
                  description: Action button copy
                url:
                  type: string
                  format: uri
                  description: Action link
              required:
                - label
                - url
              additionalProperties: false
          required:
            - title
            - description
          additionalProperties: false
        editor:
          type: string
          enum:
            - none
            - text
            - html
          description: Editor type
        contentLimits:
          type: object
          properties:
            modes:
              type: array
              items:
                type: string
                enum:
                  - article2
                  - article
                  - video
              description: Supported publishing content modes
            maxTitleLength:
              description: Maximum title length
              type: number
            maxBodyLength:
              description: Maximum text length
              type: number
            maxTotalTextLength:
              description: Maximum length of final published text
              type: number
            maxMediaCount:
              description: Maximum number of media
              type: number
            maxImages:
              description: Maximum number of pictures
              type: number
            maxVideos:
              description: Maximum number of videos
              type: number
          required:
            - modes
          additionalProperties: false
          description: Content restrictions
        mediaRules:
          type: object
          properties:
            imageFormats:
              description: Picture format
              type: array
              items:
                type: string
            videoFormats:
              description: video format
              type: array
              items:
                type: string
            maxImageSize:
              description: Maximum number of bytes of image
              type: number
            maxVideoSize:
              description: Maximum number of bytes of video
              type: number
            minVideoDuration:
              description: Minimum seconds of video
              type: number
            maxVideoDuration:
              description: Maximum seconds of video
              type: number
            minImageWidth:
              description: Image minimum width
              type: number
            minImageHeight:
              description: Minimum image height
              type: number
            maxImageWidth:
              description: Maximum image width
              type: number
            maxImageHeight:
              description: Maximum image height
              type: number
            aspectRatio:
              description: Aspect Ratio Limitations
              type: object
              properties:
                min:
                  description: minimum aspect ratio
                  type: number
                max:
                  description: Maximum aspect ratio
                  type: number
              additionalProperties: false
          additionalProperties: false
          description: media rules
        topic:
          type: object
          properties:
            supported:
              type: boolean
              description: Whether the topic is supported
            nativeField:
              description: Whether to use the platform’s native topic field
              type: boolean
            maxCount:
              description: Maximum number of topics
              type: number
            maxTotalLength:
              description: The maximum total length of the topic after serialization
              type: number
          required:
            - supported
          additionalProperties: false
          description: topic ability
        capabilities:
          type: object
          properties:
            auth:
              type: object
              properties:
                supported:
                  type: boolean
                  description: Whether to support authorization
                revoke:
                  type: boolean
                  description: Whether to support cancellation of authorization
                selectableAccounts:
                  type: boolean
                  description: Whether to support selecting sub-account after authorization
                refreshAccountAccess:
                  type: boolean
                  description: Whether to support refreshing sub-account access credentials
              required:
                - supported
                - revoke
                - selectableAccounts
                - refreshAccountAccess
              additionalProperties: false
              description: Authorization ability
            publish:
              type: object
              properties:
                supported:
                  type: boolean
                  description: Whether to support server-side publishing
                cancel:
                  type: boolean
                  description: Whether to support canceling platform-side publishing
                update:
                  type: boolean
                  description: Whether to support updating published content
                verify:
                  type: boolean
                  description: Whether to support release result verification
                finalize:
                  type: boolean
                  description: Whether to support post-release polling or closing
                scheduleByPlatform:
                  type: boolean
                  description: Whether to support platform native scheduled release
                optionSources:
                  type: boolean
                  description: Whether to support dynamic publishing options
                completionStrategy:
                  description: Release Completion Strategy
                  type: string
                  enum:
                    - sync
                    - polling
                    - media_finalize
                    - webhook
                    - user_handoff
              required:
                - supported
                - cancel
                - update
                - verify
                - finalize
                - scheduleByPlatform
                - optionSources
              additionalProperties: false
              description: publishing capabilities
            analytics:
              type: object
              properties:
                account:
                  type: boolean
                  description: Does it support account data analysis?
                work:
                  type: boolean
                  description: Does it support work data analysis?
              required:
                - account
                - work
              additionalProperties: false
              description: Data analysis capabilities
            engagement:
              type: object
              properties:
                comments:
                  type: object
                  properties:
                    list:
                      type: object
                      properties:
                        supported:
                          type: boolean
                          description: Whether to support comment list
                        pagination:
                          oneOf:
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  description: Paging mode
                                  enum:
                                    - cursor
                                defaultLimit:
                                  type: integer
                                  exclusiveMinimum: true
                                  maximum: 9007199254740991
                                  description: Default quantity
                                  minimum: 0
                                maxLimit:
                                  type: integer
                                  exclusiveMinimum: true
                                  maximum: 9007199254740991
                                  description: maximum quantity
                                  minimum: 0
                                supportsPrevious:
                                  type: boolean
                                  description: Whether to support the previous page
                              required:
                                - mode
                                - defaultLimit
                                - maxLimit
                                - supportsPrevious
                              additionalProperties: false
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  description: Paging mode
                                  enum:
                                    - page
                                defaultPageSize:
                                  type: integer
                                  exclusiveMinimum: true
                                  maximum: 9007199254740991
                                  description: Default number per page
                                  minimum: 0
                                maxPageSize:
                                  type: integer
                                  exclusiveMinimum: true
                                  maximum: 9007199254740991
                                  description: Maximum number per page
                                  minimum: 0
                                supportsTotal:
                                  type: boolean
                                  description: Whether to return the total number
                              required:
                                - mode
                                - defaultPageSize
                                - maxPageSize
                                - supportsTotal
                              additionalProperties: false
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  description: Paging mode
                                  enum:
                                    - none
                              required:
                                - mode
                              additionalProperties: false
                          description: Comment list paging capability
                        parameters:
                          type: object
                          properties:
                            querySchema:
                              type: object
                              additionalProperties: true
                              description: Query parameters JSON Schema
                              properties: {}
                            bodySchema:
                              description: Body parameter JSON Schema
                              type: object
                              additionalProperties: true
                              properties: {}
                            dataSchema:
                              description: Function data parameter JSON Schema
                              type: object
                              additionalProperties: true
                              properties: {}
                          required:
                            - querySchema
                          additionalProperties: false
                          description: Comment list parameters
                      required:
                        - supported
                        - pagination
                        - parameters
                      additionalProperties: false
                      description: Comment list capability
                    create:
                      type: object
                      properties:
                        supported:
                          type: boolean
                          description: Whether to support creating comments
                        parameters:
                          type: object
                          properties:
                            querySchema:
                              type: object
                              additionalProperties: true
                              description: Query parameters JSON Schema
                              properties: {}
                            bodySchema:
                              description: Body parameter JSON Schema
                              type: object
                              additionalProperties: true
                              properties: {}
                            dataSchema:
                              description: Function data parameter JSON Schema
                              type: object
                              additionalProperties: true
                              properties: {}
                          required:
                            - querySchema
                          additionalProperties: false
                          description: Create comment parameters
                      required:
                        - supported
                        - parameters
                      additionalProperties: false
                      description: Create comment capabilities
                  required:
                    - list
                    - create
                  additionalProperties: false
                  description: Comment ability
                functions:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        enum:
                          - delete_comment
                          - like
                          - unlike
                          - repost
                          - undo_repost
                          - quote
                          - bookmark
                          - remove_bookmark
                          - hide_reply
                          - unhide_reply
                          - follow
                          - unfollow
                        description: Interactive function name
                      label:
                        type: object
                        properties:
                          en-US:
                            type: string
                            description: English copywriting
                          zh-CN:
                            type: string
                            description: Chinese copywriting
                        required:
                          - en-US
                          - zh-CN
                        additionalProperties: false
                        description: function display copy
                      target:
                        type: string
                        enum:
                          - work
                          - comment
                          - account
                        description: Interaction target type
                      parameters:
                        type: object
                        properties:
                          querySchema:
                            type: object
                            additionalProperties: true
                            description: Query parameters JSON Schema
                            properties: {}
                          bodySchema:
                            description: Body parameter JSON Schema
                            type: object
                            additionalProperties: true
                            properties: {}
                          dataSchema:
                            description: Function data parameter JSON Schema
                            type: object
                            additionalProperties: true
                            properties: {}
                        required:
                          - querySchema
                          - bodySchema
                          - dataSchema
                        additionalProperties: false
                        description: Function parameters
                    required:
                      - name
                      - label
                      - target
                      - parameters
                    additionalProperties: false
                  description: Interactive functions supported by the platform
              required:
                - comments
                - functions
              additionalProperties: false
              description: Interactive capabilities
            work:
              type: object
              properties:
                listWorks:
                  type: boolean
                  description: Whether to support account works list
                listWorksPagination:
                  oneOf:
                    - type: object
                      properties:
                        mode:
                          type: string
                          description: Paging mode
                          enum:
                            - cursor
                        defaultLimit:
                          type: integer
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                          description: Default quantity
                          minimum: 0
                        maxLimit:
                          type: integer
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                          description: maximum quantity
                          minimum: 0
                        supportsPrevious:
                          type: boolean
                          description: Whether to support the previous page
                      required:
                        - mode
                        - defaultLimit
                        - maxLimit
                        - supportsPrevious
                      additionalProperties: false
                    - type: object
                      properties:
                        mode:
                          type: string
                          description: Paging mode
                          enum:
                            - page
                        defaultPageSize:
                          type: integer
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                          description: Default number per page
                          minimum: 0
                        maxPageSize:
                          type: integer
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                          description: Maximum number per page
                          minimum: 0
                        supportsTotal:
                          type: boolean
                          description: Whether to return the total number
                      required:
                        - mode
                        - defaultPageSize
                        - maxPageSize
                        - supportsTotal
                      additionalProperties: false
                    - type: object
                      properties:
                        mode:
                          type: string
                          description: Paging mode
                          enum:
                            - none
                      required:
                        - mode
                      additionalProperties: false
                  description: Account work list paging ability
                getLinkInfo:
                  type: boolean
                  description: Whether to support parsing work links
                getDetail:
                  type: boolean
                  description: Whether the work details are supported
                verifyOwnership:
                  type: boolean
                  description: Whether to support work attribution verification
              required:
                - listWorks
                - listWorksPagination
                - getLinkInfo
                - getDetail
                - verifyOwnership
              additionalProperties: false
              description: Work ability
            browse:
              type: object
              properties:
                search:
                  type: boolean
                  description: Whether to support search browsing
                getDetail:
                  type: boolean
                  description: Whether to support browsing details
              required:
                - search
                - getDetail
              additionalProperties: false
              description: Browsing ability
            webhook:
              type: object
              properties:
                supported:
                  type: boolean
                  description: Whether to support webhook
              required:
                - supported
              additionalProperties: false
              description: Webhook capabilities
          required:
            - auth
            - publish
            - analytics
            - engagement
            - work
            - browse
            - webhook
          additionalProperties: false
          description: Platform operation capability
        optionSchema:
          type: object
          additionalProperties: true
          description: Publish options JSON Schema
          properties: {}
        defaultOption:
          description: Default publishing options
          type: object
          additionalProperties: true
          properties: {}
        status:
          type: string
          enum:
            - hidden
            - available
            - unavailable
            - coming_soon
          description: Platform status
      required:
        - platform
        - displayName
        - logoUrl
        - authType
        - editor
        - contentLimits
        - mediaRules
        - topic
        - capabilities
        - optionSchema
        - status
      additionalProperties: false

````