Skip to main content

Input Parameters and Schema

input_values is the task’s input parameter object. Keys follow the format NodeID:NodeName.FieldName, and values can be strings, numbers, booleans, etc. The available fields depend on the workflow structure associated with the web_app_id.

How to find the schema

  1. Go to the BizyAir AI Apps page
  2. Click the target AI app to open its detail page
  3. Click the API button in the top-left corner
  4. In the API call dialog, review the full list of input_values fields and their example values
  5. Switch to the Shell / Python / JavaScript tabs to copy a complete code snippet

Common field patterns

File Upload

When a workflow requires images, audio, or video as input (e.g. image-to-image, image-to-video), you must first upload the file to BizyAir OSS, then pass the returned url as the value of the corresponding input_values field.

Step 1: Get upload credentials

Response:
file_name must include the file extension — the server uses it to determine the file type. The returned STS credentials are temporary; do not persist them or expose them in frontend code.

Step 2: Upload the file to Alibaba Cloud OSS

Use the returned credentials to PUT the file directly to OSS. See Alibaba Cloud OSS Simple Upload for details. Python example:
Node.js example:

Step 3: Register the input resource

After the OSS upload succeeds, call the commit endpoint to register the file and obtain a url that the workflow can reference.
Response:
The returned url can then be passed as the value of the corresponding field in input_values when creating a task.

Output Files and Object URLs

After a task completes successfully, outputs[].object_url provides a temporary download link for the result file:
  • Domain: https://storage.bizyair.ai/outputs/...
  • Default validity: 15 days (the expired_at field in the response gives the exact time)
  • After expiry: cannot be recovered
In production, download the file to your own object storage (OSS / S3) as soon as you receive the object_url to avoid link expiration.

Task Duration Breakdown

The task result includes a cost_times object with detailed durations for each stage (in milliseconds):
Billing is based solely on inference_cost_time (the inference phase). All other stages are free of charge.