Channel Management/Platforms

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” 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” interface.

GET

/

api

/

v2

/

channels

/

platforms

/

{platform}

/

publish-options

Platform Publish Options

curl --request GET \
  --url https://aitoearn.cn/api/v2/channels/platforms/{platform}/publish-options \
  --header 'X-Api-Key: <api-key>'

{
  "code": 0,
  "message": "Request succeeded",
  "data": [
    {
      "field": "string",
      "label": "string",
      "valueType": "list",
      "requiresAccount": true,
      "description": "string",
      "filterSchema": {},
      "createSchema": {}
    }
  ]
}

Authorizations

X-Api-Key

string

header

required

Need to get API Key from AiToEarn. Click to go to "API Key Obtaining Tutorial".

Path Parameters

platform

string

required

Platform ID. The value comes from the data[n].platform returned by the "Platform List" interface (GET /api/v2/channels/platforms).

Response

200 - application/json

The request has been processed by the service. Business success is determined by whether the response body has code === 0.

code

integer

required

Business status code. 0 means success; non-zero means a business error.

message

string

required

Response message.

data

object[]

Hide child attributes

data.field

string

required

Publishing options field

data.label

string

required

display name

data.valueType

enum<string>

required

Value structure

Available options:

list,

tree

data.requiresAccount

boolean

required

Is account authorization required?

data.description

string

illustrate

data.filterSchema

object

filter schema

data.createSchema

object

Create parameter schema

requestId

string

Request ID.

timestamp

integer

Error response timestamp in Unix milliseconds.

Parse Work Link

Platform Publish Options

curl --request GET \
  --url https://aitoearn.cn/api/v2/channels/platforms/{platform}/publish-options \
  --header 'X-Api-Key: <api-key>'

{
  "code": 0,
  "message": "Request succeeded",
  "data": [
    {
      "field": "string",
      "label": "string",
      "valueType": "list",
      "requiresAccount": true,
      "description": "string",
      "filterSchema": {},
      "createSchema": {}
    }
  ]
}