Multiview image

Generate and edit multiview reference images for downstream 3D workflows.

Generate multiview image

Once the task moves out of the waiting queue, it typically completes within a few seconds. This task costs 10 credits per request.

Endpoint

Parameters

Required parameters

type: Must be set to generate_multiview_image.

file: Specifies the image input.

• type: Indicates the file type. Although currently not validated, specifying the correct file type is strongly advised.
• file_token: The identifier you get from upload, please refer to part of Upload directly. Mutually exclusive with url and object.
• url: A direct URL to the image. Supports JPEG and PNG formats with a maximum size of 20MB. Mutually exclusive with file_token and object.
• object (Strongly Recommended): The information you get from upload, please refer to Upload in STS. Mutually exclusive with url and file_token.
  • bucket: Normally it always will be tripo-data.
  • key: The resource_uri from returns.

Returns

task_id: The identifier for the successfully submitted task.

Behaviour

The default concurrency limit for generate_multiview_image is 1. For details, see Rate limits.

For task result fields in output, see Get your task result.

Edit multiview image

Once the task moves out of the waiting queue, it typically completes within a few seconds. This task costs 5 credits per edited view.

Endpoint

Parameters

Required parameters

type: Must be set to edit_multiview_image.

original_task_id: The task_id generated by generate_multiview_image.

prompts: A list of edit prompts for specific view images.

• prompt: The edit instruction for the selected view.
• view: The view to edit. Available values are front, left, back, and right.

Returns

task_id: The identifier for the successfully submitted task.

Behaviour

The default concurrency limit for edit_multiview_image is 1. For details, see Rate limits.

For task result fields in output, see Get your task result.