Server-side Rendering Free Trial Guide

This guide is intended for customers who want to evaluate Meishe server-side rendering. No local rendering-service deployment is required for the trial. After obtaining a trial API Key, you can use an existing JSON example to create a rendering task, monitor its progress, and review the generated video.

The trial consists of four steps: obtain trial credentials, prepare JSON, create a task, and retrieve the result.

Before you begin

Prepare a local computer capable of sending HTTP requests, then contact Meishe Sales for the following trial information:

• A server-side rendering API Key for request authentication;

The API Key is used only to authenticate API requests during the free trial. Store it securely, and do not include it in a public source-code repository, client-side web application, or externally shared log.

Step 1: Obtain an API Key

Visit the Meishe website and contact Meishe Sales to request a trial of the server-side rendering service. After the trial is enabled, you will receive the API Key required to call the service.

When calling the API, add the API Key to the Authorization request header for authentication.

Step 2: Prepare complete JSON

Open the Quick-trial JSON examples, select a category close to the effect you want to evaluate, and copy the complete JSON from one of its child pages. A complete example already contains the data structure required for a rendering task and is the fastest way to complete a first trial.

When preparing the JSON:

• Copy the complete JSON rather than an individual field or parameter fragment;
• If you replace a video, audio, or image asset, ensure that the rendering service can access its URL;
• If you replace a resource-package ID, confirm that the package is installed in the trial environment;
• For the first trial, complete the basic flow first, then adjust the resolution, captions, transitions, effects, and other content progressively.

Step 3: Create a rendering task

Open Start a synthesis task and follow the page instructions to call the task-creation API from your local environment:

1. Call the synthesis API;
2. Include the API Key as required;
3. Put the JSON prepared in the previous step into the corresponding request parameter;
4. Send the request and check the API response.

After the task is created successfully, the response contains a taskId. Save this value because it is required to query progress and retrieve the result.

If the task-creation API immediately returns an error, check the API Key, request URL, HTTP method, and JSON format.

Step 4: View progress and the rendered result

After creating the task, retrieve its execution state in one of the following ways.

Query the task

Open Query task results and query progress with the taskId. This is the recommended approach for a first trial because it does not require a callback service.

When the task is complete and successful, the response provides the rendered-video URL. Open the video and verify that the picture, audio, captions, and effects match your expectations. Download the trial output promptly according to the retention notice on the result page.

Receive callbacks

See:

• Progress callback to receive task progress;
• Result callback to receive completion status and the rendered result.

Trial completion checklist

The basic server-side rendering flow is working when all of the following are true:

• The task-creation API call succeeds;
• A valid taskId is returned;
• Task progress can be queried or callbacks are received successfully;
• The task completes successfully and returns a rendered-video URL;
• The video opens correctly and matches the selected JSON example.

Troubleshooting

Authentication failure

Confirm that the API Key belongs to the current trial environment and that the authentication information is included in the request as instructed. Do not disclose the API Key while troubleshooting.

Invalid request parameters

Copy the complete content from the JSON examples again, then compare the request-body structure, HTTP method, and Content-Type with Start a synthesis task.

Media cannot be accessed

Confirm that every video, audio, and image URL in the JSON is valid and accessible to the rendering service. A local file path that works only on your computer cannot be used directly as a remote rendering asset URL.

Task execution failure

Review the error information returned by Query task results. If the cause cannot be identified, provide the taskId, error message, and reproduction steps to Meishe technical support. Do not provide the API Key.

Next steps

After completing the first trial, read the Timeline JSON data structure description to learn how to customize video content. To process multiple synthesis or transcoding tasks, see Batch Rendering for deployment and scaling options.