> ## 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 Publish Options

> Interface description: Query whether a platform requires platform-specific additional parameters when publishing, as well as the field names, value structures and creation rules of these parameters.

Each `data[n]` returned represents an additional argument. Common scenarios include B station partition `tid`, YouTube category `categoryId`, Threads location `location_id`, and Pinterest Board `boardId`. If an empty array is returned, it means that the platform currently has no additional parameters that need to be processed through the publishing options interface.

Usage: Get the `field` in the returned item and put it into ["Publish option optional values"](/en/api-reference/get-api-v2-channels-accounts-account-id-publish-options-field-values) interface path parameter `field` to query the optional value; if the returned item contains `filterSchema`, pass the filter conditions as query parameters to the "Publish option optional values" interface according to the schema; if the returned item contains `createSchema`, indicating that this field supports the creation of new values. You can organize the request body according to `createSchema` and call the ["Create publish option values"](/en/api-reference/post-api-v2-channels-accounts-account-id-publish-options-field-values) interface.



## OpenAPI

````yaml /openapi/en/aitoearn.openapi.json get /api/v2/channels/platforms/{platform}/publish-options
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/{platform}/publish-options:
    get:
      tags:
        - Channel Management/Platforms
      summary: Platform Publish Options
      description: >-
        Interface description: Query whether a platform requires
        platform-specific additional parameters when publishing, as well as the
        field names, value structures and creation rules of these parameters.


        Each `data[n]` returned represents an additional argument. Common
        scenarios include B station partition `tid`, YouTube category
        `categoryId`, Threads location `location_id`, and Pinterest Board
        `boardId`. If an empty array is returned, it means that the platform
        currently has no additional parameters that need to be processed through
        the publishing options interface.


        Usage: Get the `field` in the returned item and put it into ["Publish
        option optional
        values"](/en/api-reference/get-api-v2-channels-accounts-account-id-publish-options-field-values)
        interface path parameter `field` to query the optional value; if the
        returned item contains `filterSchema`, pass the filter conditions as
        query parameters to the "Publish option optional values" interface
        according to the schema; if the returned item contains `createSchema`,
        indicating that this field supports the creation of new values. You can
        organize the request body according to `createSchema` and call the
        ["Create publish option
        values"](/en/api-reference/post-api-v2-channels-accounts-account-id-publish-options-field-values)
        interface.
      operationId: PlatformsController_listPublishOptions_v2
      parameters:
        - name: platform
          in: path
          description: >-
            Platform ID. The value comes from the `data[n].platform` returned by
            the ["Platform
            List"](/en/api-reference/get-api-v2-channels-platforms) interface
            (`GET /api/v2/channels/platforms`).
          required: true
          example: ''
          schema:
            type: string
            description: >-
              Platform ID. The value comes from the `data[n].platform` returned
              by the ["Platform
              List"](/en/api-reference/get-api-v2-channels-platforms) interface
              (`GET /api/v2/channels/platforms`).
      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/PublishOptionSourceVo'
                  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:
                      - field: string
                        label: string
                        valueType: list
                        requiresAccount: true
                        description: string
                        filterSchema: {}
                        createSchema: {}
                validationFailed10002:
                  summary: ValidationFailed (10002)
                  value:
                    code: 10002
                    message: Parameter validation failed
                    data: {}
                    timestamp: 1772099056662
                unauthorized401:
                  summary: Unauthenticated or invalid API Key
                  value:
                    code: 401
                    message: Unauthorized
                    data: {}
                    timestamp: 1772099056662
      deprecated: false
      security:
        - apikey-header-X-Api-Key: []
components:
  schemas:
    PublishOptionSourceVo:
      type: object
      properties:
        field:
          type: string
          description: Publishing options field
        label:
          type: string
          description: display name
        description:
          description: illustrate
          type: string
        valueType:
          type: string
          enum:
            - list
            - tree
          description: Value structure
        requiresAccount:
          type: boolean
          description: Is account authorization required?
        filterSchema:
          description: filter schema
          type: object
          additionalProperties: true
          properties: {}
        createSchema:
          description: Create parameter schema
          type: object
          additionalProperties: true
          properties: {}
      required:
        - field
        - label
        - valueType
        - requiresAccount
  securitySchemes:
    apikey-header-X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Need to get API Key from AiToEarn. Click to go to ["API Key Obtaining
        Tutorial"](/en/use/api-key).

````