What If a Script Malfunctions After I Created or Updated It Using an API?

You can edit a script on the console or by calling an API. The restrictions on both methods are as follows:

• The script thumbnail is only for reference when you edit a script on the console. It does not represent the final visual effect.
• The parameters of the API may be logically related. A script created using the API may malfunction due to incorrect or inaccurate parameter input. You need to check the input parameters by referring to the API document.
• You can edit a script on the console or by calling an API. However, you are not advised to use both methods at the same time.

  A script created using incorrect API parameter input may cause exceptions on the console. You need to edit the script on the console or by inputting API parameters correctly.

Possible causes of console exceptions after API calling:

• Fields that do not exist in the API document are used.
• Parameters required for rendering are missing.
• Invalid parameter value. For example, the value type is invalid or the value exceeds the range.
• Incorrect scene sequence. For example, the value of sequence_no in shoot_scripts must start from 0 and increase in ascending order.
• Incorrect overlay sequence. For example, the value of layer_index in layer_config must start from 1 and increase in ascending order.
• The position and size of an overlay do not meet the actual requirements. For example, a text overlay is too large and exceeds the preview area.
• The asset does not exist or the asset type is incorrect.