Auto Swith to Public Computing Pool

Only clients with dedicated lines can access this endpoint. This is a switch applying to your entire account. When set to true, videos generation requests created by/api/v1/video/generate will automatically be sent to the public computing pool if your dedicated lines are all being used.

As a dedicated line user, there is no monthly video generation limit set by us. Your capacity is determined by how many videos your dedicated lines can process within a month. This endpoint allows you to send video generation requests to the public computing pool when your dedicated lines are occupied. For example, if you have two dedicated lines but three video generation requests are created simultaneously, the third request would typically wait until one of the lines becomes available. However, if you choose to utilize the public pool, all three requests can be processed concurrently, ensuring faster results and increased efficiency.

The requests sent to the public computing pool will consume your coins as regular user's requests. The purpose of sending your requests to the public computing pool is to accelerate the process of your video generation by using more computing resources. But this will increase your cost (you need to prepare enough coins).

This endpoint acts as a switch for your entire account. Its default value is false. If you turn the switch on, please remember to turn it off otherwise it will be kept as on forever. If you want to individually control if a video generation request should be redirected to the public computing pool, please set isToPublicPool parameter of the endpoint of /api/v1/video/generate

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

isAutoToPublicPool

boolean

required

Whether to automatically go to the public pool,default false.

Example

{
    "isAutoToPublicPool": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

code

integer

required

0 is OK

data

object

required

isAutoToPublicPool

boolean

required

trace_id

string

required

Example

{
    "code": 0,
    "data": {
        "isAutoToPublicPool": true
    },
    "trace_id": "2fe76eed-155d-403e-be6d-08922a60d553"
}

🟠403Forbidden