# Topview Documentation > Documentation for Topview ## Guides: documentation - [Getting Started with Topview API](https://docs.topview.ai/docs/getting-started.md): Get started with TopView API quickly - [Billing Rules](https://docs.topview.ai/docs/billing-rules.md) - [Concurrency and Storage](https://docs.topview.ai/docs/concurrency-and-storage.md) ## API Reference: Topview-api - [Authentication](https://docs.topview.ai/reference/authentication-1.md) - [Response Code](https://docs.topview.ai/reference/error-response.md) - [Points Deduction Rules](https://docs.topview.ai/reference/rules-for-consumption-rules.md) - Image Character Swap - [Image Character Swap API Usage](https://docs.topview.ai/reference/image-character-swap-api-usage.md) - [Submit Task](https://docs.topview.ai/reference/v1-character-swap-task-submit.md) - [Query Task](https://docs.topview.ai/reference/v1-character-swap-task-query.md) - Video Character Swap - [Video Character Swap API Usage](https://docs.topview.ai/reference/video-character-swap-api-usage.md) - Video Process - [Submit Task](https://docs.topview.ai/reference/video_process_submit_task.md) - [Query Task](https://docs.topview.ai/reference/video_process_query_task.md) - Image Mask Drawing - [Submit Task](https://docs.topview.ai/reference/image_mask_drawing_submit_task.md) - [Query Task](https://docs.topview.ai/reference/image_mask_drawing_query_task.md) - Video Mask Drawing - [Submit Task](https://docs.topview.ai/reference/video_mask_drawing_submit_task.md) - [Query Task](https://docs.topview.ai/reference/video_mask_drawing_query_task.md) - Video Character Swap - [Submit Task](https://docs.topview.ai/reference/video_character_swap_submit_task.md) - [Query Task](https://docs.topview.ai/reference/video_character_swap_query_task.md) - Image Translate - [Image Translate API Usage](https://docs.topview.ai/reference/image-translate-api-usage.md) - Single Image - [Submit Translate Task](https://docs.topview.ai/reference/submit-translate-task.md) - [Query Translate Task](https://docs.topview.ai/reference/query-translate-task.md) - [Submit Single Generate Task](https://docs.topview.ai/reference/submit-single-generate-task.md) - Batch Image - [Submit Batch Generate Task](https://docs.topview.ai/reference/submit-batch-generate-task.md) - [Query Generate Task](https://docs.topview.ai/reference/query-generate-task.md) - [Photo Avatar / Avatar4](https://docs.topview.ai/reference/avatar-4.md): The latest-generation avatar model - [Photo Avatar API Usage](https://docs.topview.ai/reference/photo-avatar4-api-usage.md) - [Avatar List](https://docs.topview.ai/reference/photo_avatar_list.md) - [Avatar Category List](https://docs.topview.ai/reference/avatar_category_list.md) - [Create Custom Avatar](https://docs.topview.ai/reference/create_custom_avatar.md) - [Delete Custom Avatar](https://docs.topview.ai/reference/delete_custom_avatar.md) - [Submit Task](https://docs.topview.ai/reference/avatar4_submit_task.md): Submit an asynchronous Photo Avatar task. Returns a `taskId`; poll the [Query Task](/v1/photo_avatar/task/query) endpoint for the result. **Script source (scriptMode)**: - `text`: text-to-speech,… - [Query Task](https://docs.topview.ai/reference/avatar4_query_task.md): Query the status and result of a Photo Avatar task by `taskId`. Recommended polling interval 3-5 seconds, timeout 5 minutes. **Task status (status)**: `init` submitted and waiting; `running`… - Avatar Marketing Video - [Getting Started](https://docs.topview.ai/reference/getting-started-1.md) - [Submit Task](https://docs.topview.ai/reference/avatar_marketing_video_submit_task.md) - [Query Task](https://docs.topview.ai/reference/get_m2v-task-query.md) - [Export Task](https://docs.topview.ai/reference/avatar_marketing_video_export_task.md) - [List Task](https://docs.topview.ai/reference/avatar_marketing_video_list_task.md) - [Delete Task](https://docs.topview.ai/reference/avatar_marketing_video_delete_task.md) - Script Related - [List Script Content](https://docs.topview.ai/reference/avatar_marketing_video_list_script_content.md) - [Update Script Content](https://docs.topview.ai/reference/avatar_marketing_video_update_script_content.md) - Video Avatar - [Getting Started](https://docs.topview.ai/reference/getting-started-2.md) - [Submit Task](https://docs.topview.ai/reference/video_avatar_submit_task.md) - [Query Task](https://docs.topview.ai/reference/video_avatar_query_task.md) - Product Avatar - [Category Query](https://docs.topview.ai/reference/pa_category_query.md) - [Public Product Avatar Query](https://docs.topview.ai/reference/pa_public_product_avatar_query.md) - V3 - [Getting Started](https://docs.topview.ai/reference/pa3_getting_started.md) - [Submit Task(Replace Product Image)](https://docs.topview.ai/reference/pa3_replace_product_image_submit_task.md) - [Query Task(Replace Product Image)](https://docs.topview.ai/reference/pa3_replace_product_image_query_task.md) - [Submit Task(Image2Video)](https://docs.topview.ai/reference/pa3_image2video_submit_task.md) - [Query Task(Image2Video)](https://docs.topview.ai/reference/pa3_image2video_query_task.md) - Product AnyShoot - V3 - Product+Model(Virtual Try-on) - [Product Model API Usage](https://docs.topview.ai/reference/product-model-api-usage-v3.md) - [Submit Task(Product Model)](https://docs.topview.ai/reference/product_anyshoot_v3_product_model_submit_task.md) - [Query Task(Product Model)](https://docs.topview.ai/reference/product_anyshoot_v3_product_model_query_task.md) - [Template Category](https://docs.topview.ai/reference/product_anyshoot_v3_product_model_template_category.md) - [Template List](https://docs.topview.ai/reference/product_anyshoot_v3_product_model_template_list.md) - V3 - Product+Background - [Product Background API Usage](https://docs.topview.ai/reference/product-background-api-usage-v3.md) - [Location Parameters Document](https://docs.topview.ai/reference/location-parameters-document-v3.md) - [Submit Task(Product Background)](https://docs.topview.ai/reference/product_anyshoot_v3_product_background_submit_task.md) - [Query Task(Product Background)](https://docs.topview.ai/reference/product_anyshoot_v3_product_background_query_task.md) - [Template List](https://docs.topview.ai/reference/product_anyshoot_v3_product_background_template_list.md) - [Save Custom Template](https://docs.topview.ai/reference/product_anyshoot_v3_product_background_save_template.md) - [Delete Custom Template](https://docs.topview.ai/reference/product_anyshoot_v3_product_background_delete_template.md) - V2 - Product+Model (Virtual Try-on) - [Product Model API Usage](https://docs.topview.ai/reference/product-model-api-usage.md) - [Submit Task(Product Model)](https://docs.topview.ai/reference/product_anyshoot_v2_product_model.md) - [Query Task(Product Model)](https://docs.topview.ai/reference/get_new-endpoint-49.md) - [Template Category](https://docs.topview.ai/reference/get_new-endpoint-52.md) - [Template List](https://docs.topview.ai/reference/get_new-endpoint-51.md) - V2 - Product+Background - [Product Background API Usage](https://docs.topview.ai/reference/product-background-api-usage.md) - [Location Parameters Document](https://docs.topview.ai/reference/location-parameters-document.md) - [Submit Task(Product Background)](https://docs.topview.ai/reference/get_new-endpoint-44.md) - [Query Task(Product Background)](https://docs.topview.ai/reference/get_new-endpoint-45.md) - [Template List](https://docs.topview.ai/reference/get_new-endpoint-46.md) - [Save Custom Template](https://docs.topview.ai/reference/get_new-endpoint-47.md) - [Delete Custom Template](https://docs.topview.ai/reference/get_new-endpoint-48.md) - V1 - [Submit Task(Replace Product Image)](https://docs.topview.ai/reference/product_anyshoot_v1.md) - [Query Task(Replace Product Image)](https://docs.topview.ai/reference/get_new-endpoint-18.md) - [Template Category](https://docs.topview.ai/reference/get_new-endpoint-19.md) - [Template List](https://docs.topview.ai/reference/get_new-endpoint-20.md) - Common Task - [Image-to-Video V2 / Text-to-Video / Omni Reference API Usage](https://docs.topview.ai/reference/image-to-video-v2-text-to-video-omni-reference-api-usage.md) - [Text-to-Image / Image Edit Task API Usage](https://docs.topview.ai/reference/text-to-image-image-edit-task-api-usage.md) - Image2Video (V1) - [Submit Task](https://docs.topview.ai/reference/get_new-endpoint-21.md): Remark: The Lite model will be officially removed from the platform on May 14, 2026. - [Query Task](https://docs.topview.ai/reference/get_new-endpoint-22.md) - Image2Video (V2) - [Submit Task](https://docs.topview.ai/reference/image_to_video_v2_submit_task.md): Submit an image-to-video generation task using the V2 API. Supports multiple input modes: single image, first/last frames, or multiple reference images. Supports multiple AI models with customizable… - [Query Task](https://docs.topview.ai/reference/image_to_video_v2_query_task.md): Query the result of an image-to-video generation task using the V2 API. Returns the task status, generated videos, and related information. Different responses are returned based on task status:… - Text2Video - [Submit Task](https://docs.topview.ai/reference/text_to_video_submit_task.md): Convert text prompts to video content. Supports multiple AI models with customizable resolution, aspect ratio, duration, and other parameters. Returns a taskId for asynchronous result polling. - [Query Task](https://docs.topview.ai/reference/text_to_video_query_task.md): Query the result of a text-to-video generation task. Returns the task status, generated videos, and related information. Different responses are returned based on task status: init/running… - Omni Reference - [Submit Task](https://docs.topview.ai/reference/omni_reference_submit_task.md): Submit an Omni Reference video generation task. Omni Reference is an advanced video editing/generation feature that supports reference images and videos to guide the generation process. Supports… - [Query Task](https://docs.topview.ai/reference/omni_reference_query_task.md): Query the result of an Omni Reference video generation task. Returns the task status, generated videos, and related information. Different responses are returned based on task status: init/running… - Motion Control - [Motion Control API Usage](https://docs.topview.ai/reference/motion-control-api-usage-1.md) - [Submit Task](https://docs.topview.ai/reference/motion_control_submit_task.md): Submit an async Motion Control task and receive `taskId`. Poll the query endpoint for final result. Constraints: - Input resources are fileIds - Character image supports jpg/jpeg/png - Motion… - [Query Task](https://docs.topview.ai/reference/motion_control_query_task.md): Query Motion Control task status and output by `taskId`. Unfinished tasks are returned as `running`. - Text2Image - [Submit Task](https://docs.topview.ai/reference/text_to_image_submit_task.md): Submit a text-to-image generation task. The system will generate images based on the provided prompt and model specifications. For sample requests and model descriptions, please refer to the… - [Query Task](https://docs.topview.ai/reference/text_to_image_query_task.md): Query the status and result of a previously submitted text-to-image generation task. - Image Edit - [Submit Task](https://docs.topview.ai/reference/image_edit_submit_task.md): Submit an image editing task. The system will apply AI-powered edits to the reference images based on the provided prompt and model specifications. For sample requests and model descriptions, please… - [Query Task](https://docs.topview.ai/reference/image_edit_query_task.md): Query the status and result of a previously submitted image editing task. - Video2Aiavatar - [Submit Task](https://docs.topview.ai/reference/video2aiavatar_submit_task.md) - [Query Task](https://docs.topview.ai/reference/video2aiavatar_query_task.md) - Image Remove Background - [Submit Task](https://docs.topview.ai/reference/image_remove_background_v1_submit_task.md) - [Query Task](https://docs.topview.ai/reference/image_remove_background_v1_query_task.md) - [Caption List](https://docs.topview.ai/reference/get_v1-caption-list.md) - [Voice Query ](https://docs.topview.ai/reference/voice_query.md) - [AiAvatar Query](https://docs.topview.ai/reference/aiavatar-query.md) - [Check Notice Url](https://docs.topview.ai/reference/post_notice-notice-url-check.md) - [Delete Custom Avatar](https://docs.topview.ai/reference/delete_v1-aiavatar-delete-customaiavatar.md) - [Delete Custom Voice](https://docs.topview.ai/reference/delete_v1-voice-clone-delete.md) - [Ethnicity Query](https://docs.topview.ai/reference/get_v1-ethnicity-list.md) - Scraper - [Submit Scraper Task](https://docs.topview.ai/reference/scrapper_submit_task.md) - [Query Scraper Task](https://docs.topview.ai/reference/scrapper_query_task.md) - Upload - [ Upload API Usage](https://docs.topview.ai/reference/upload-api-usage.md) - [Get Upload Credential](https://docs.topview.ai/reference/get_upload_credential.md) - [Upload File ](https://docs.topview.ai/reference/upload_file_to_s3.md) - [Get Upload Check](https://docs.topview.ai/reference/get_upload_check.md): check if the file is exist - Voice - Voice Clone - [Submit Task ](https://docs.topview.ai/reference/voice_clone_submit_task.md) - [Query Task](https://docs.topview.ai/reference/get_new-endpoint-33.md) - Text2Voice - [Submit Task ](https://docs.topview.ai/reference/text2voice_submit_task.md) - [Query Task](https://docs.topview.ai/reference/text2voice_query_task.md) - User - [Query User Credit](https://docs.topview.ai/reference/query_user_credit.md) - [Query Credit Logs](https://docs.topview.ai/reference/query_credit_logs.md) - [Query User Space](https://docs.topview.ai/reference/get_new-endpoint-42.md) - Board - [List Boards](https://docs.topview.ai/reference/listboards.md): Get a paginated list of Boards belonging to the current user. - [Get Board Detail](https://docs.topview.ai/reference/getboarddetail.md): Get detailed information about a specific Board. - [Create Board](https://docs.topview.ai/reference/createboard.md): Create a new Board for the current user. - [Update Board](https://docs.topview.ai/reference/updateboard.md): Update Board information (e.g., name). Only Board owner can update. - [Delete Board](https://docs.topview.ai/reference/deleteboard.md): Delete a Board. Only Board owner can delete. This operation cannot be undone. - Board Task - [List Board Tasks](https://docs.topview.ai/reference/listboardtasks.md): Get a paginated list of tasks within a Board. Supports filtering by media type, rating, tool category, tool type, and sorting. - [Get Board Task Detail](https://docs.topview.ai/reference/getboardtaskdetail.md): Get detailed information about a specific Board task. - [Batch Delete Tasks](https://docs.topview.ai/reference/batchdeletetasks.md): Batch delete tasks from a Board. This is a synchronous operation. You can either delete specific tasks by ID list or delete all tasks matching filter criteria. - [Submit Batch Download](https://docs.topview.ai/reference/submitbatchdownload.md): Submit a batch download request for Board tasks. This is an asynchronous operation that packages selected tasks into a ZIP file. Returns a downloadTaskId for status polling. - [Get Batch Download Status](https://docs.topview.ai/reference/getbatchdownloadstatus.md): Query the status of a batch download task. Use this to poll for download progress and retrieve the download URL when ready. - Video Object Remove - [selectionBox Parameter Reference](https://docs.topview.ai/reference/selectionbox-parameter-reference.md) - [Submit Task](https://docs.topview.ai/reference/video-object-remove-submit-task.md): Submit an asynchronous video object-remove task. Returns a taskId for polling via the query API. Credits are charged after completion based on video duration. Use costCredit in the query response to… - [Query Task](https://docs.topview.ai/reference/video-object-remove-query-task.md): Poll task status and outputs by taskId. Output fields are empty until the task succeeds. On success, returns the output video URL, cover URL, file IDs, and dimension info. - AI Music - [Submit Task](https://docs.topview.ai/reference/ai-music-submit-task.md): Submit an asynchronous AI music generation task. Returns a `taskId` for polling results via the [Query Task](https://docs.topview.ai/update/reference/ai-music-query-task) API.**Models**: Supports… - [Query Task](https://docs.topview.ai/reference/ai-music-query-task.md): Query the status and output of an AI music generation task by taskId. `outputs` is empty while the task is in progress; on success, returns the generated audio fileId and access URL. **Status**:… - StoryBoard - [Submit Task](https://docs.topview.ai/reference/storyboard-submit-task.md): Submit an asynchronous Storyboard image generation task. Returns a `taskId` for polling results via the [Query Task](https://docs.topview.ai/update/reference/storyboard-query-task) API.The system… - [Query Task](https://docs.topview.ai/reference/storyboard-query-task.md): Query the status and output of a Storyboard image generation task by taskId. `images` is empty or in progress while the task is unfinished; on success, returns the generated storyboard grid image… - Instant Voice Clone - [Instant Voice Clone API](https://docs.topview.ai/reference/instant-voice-clone-api.md) - [Submit Task](https://docs.topview.ai/reference/submitinstantvoiceclonetasken.md): Submit an async Instant Voice Clone task and receive `taskId`. Poll the query endpoint for final result. V1 constraints: - `model` supports `Index TTS` and `Fish Audio S2 Pro` -… - [Query Task](https://docs.topview.ai/reference/queryinstantvoiceclonetasken.md): Query task status and output by `taskId`. Unfinished tasks are returned as `running`. ## Changelog - [Product Anyshoot Add V3 Version](https://docs.topview.ai/changelog/product-anyshoot-product-model-add-v3-version.md) - [Product Avatar Add V3 Version](https://docs.topview.ai/changelog/product-avatar-add-v3-version.md) - [Add API Related To Video Character Swap](https://docs.topview.ai/changelog/add-api-related-to-video-character-swap.md) - [Add pronRules To Text2voice](https://docs.topview.ai/changelog/add-pronunciation-rules-to-text2voice.md) - [Add keepTarget To Product Avatar V2](https://docs.topview.ai/changelog/add-keeptarget-to-product-avatar-v2.md) - [Add targetAudience To Avatar Marketing Video](https://docs.topview.ai/changelog/changed.md) - [Add API Related To Image Translate](https://docs.topview.ai/changelog/add-api-related-to-image-translate.md) - [Add API Related To Avatar](https://docs.topview.ai/changelog/add-api-related-to-avatar.md) - [Add API Related To Product AnyShoot](https://docs.topview.ai/changelog/add-api-related-to-product-anyshoot.md) - [Add API Related To Voice](https://docs.topview.ai/changelog/20250715.md)