Channel Management/Accounts

Publish Option Values

Interface description: Query the optional values of an authorized channel account under the specified publishing option field, which is used to allow users to select additional parameters required by the platform before creating a publishing task.

This interface is used for querying all additional parameters on the platform side. Typical scenarios include B station partition tid, YouTube category categoryId, Threads location location_id, and Pinterest Board boardId.

Calling process: First call the “Platform Publish Options” interface (GET /api/v2/channels/platforms/{platform}/publish-options) to query what additional parameters the platform has; put the field in the return item into the path parameter field of this interface. If the returned item contains filterSchema, pass the filter conditions as the query parameter of this interface according to the schema. For example, for the Threads location, you can pass keyword or latitude and longitude.

GET

/

api

/

v2

/

channels

/

accounts

/

{accountId}

/

publish-options

/

{field}

/

values

Publish Option Values

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

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "field": "string",
    "valueType": "list",
    "items": {}
  }
}

Authorizations

X-Api-Key

string

header

required

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

Path Parameters

accountId

string

required

Channel account ID. It must be an account authorized by the current user, and the platform to which the account belongs should be consistent with the platform queried in the "Platform Publishing Options" interface.

field

string

required

Publishing options field. The value comes from the data[n].field returned by the "Platform Publish Options" interface, such as tid, categoryId, location_id, boardId.

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

enum<string>

required

Value structure

Available options:

list,

tree

data.items

object[]

required

Options list

requestId

string

Request ID.

timestamp

integer

Error response timestamp in Unix milliseconds.

Account Authorization Status

Create Publish Option Value

Publish Option Values

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

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "field": "string",
    "valueType": "list",
    "items": {}
  }
}