Skip to content

Latest commit

 

History

History
230 lines (224 loc) · 35.2 KB

File metadata and controls

230 lines (224 loc) · 35.2 KB

Documentation for API endpoints

All URIs are relative to https://api.aspose.cloud/v3.0

Class Method HTTP request Description
ImagingApi add_search_image POST /imaging/ai/imageSearch/{searchContextId}/image Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi add_search_image_async POST /imaging/ai/imageSearch/{searchContextId}/image Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi append_tiff POST /imaging/tiff/{name}/appendTiff Appends existing TIFF image to another existing TIFF image (i.e. merges TIFF images).
ImagingApi append_tiff_async POST /imaging/tiff/{name}/appendTiff Appends existing TIFF image to another existing TIFF image (i.e. merges TIFF images).
ImagingApi compare_images POST /imaging/ai/imageSearch/{searchContextId}/compare Compare two images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi compare_images_async POST /imaging/ai/imageSearch/{searchContextId}/compare Compare two images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi convert_image GET /imaging/{name}/convert Convert existing image to another format.
ImagingApi convert_image_async GET /imaging/{name}/convert Convert existing image to another format.
ImagingApi convert_tiff_to_fax GET /imaging/tiff/{name}/toFax Update parameters of existing TIFF image accordingly to fax parameters.
ImagingApi convert_tiff_to_fax_async GET /imaging/tiff/{name}/toFax Update parameters of existing TIFF image accordingly to fax parameters.
ImagingApi copy_file PUT /imaging/storage/file/copy/{srcPath} Copy file
ImagingApi copy_file_async PUT /imaging/storage/file/copy/{srcPath} Copy file
ImagingApi copy_folder PUT /imaging/storage/folder/copy/{srcPath} Copy folder
ImagingApi copy_folder_async PUT /imaging/storage/folder/copy/{srcPath} Copy folder
ImagingApi create_converted_image POST /imaging/convert Convert existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_converted_image_async POST /imaging/convert Convert existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_cropped_image POST /imaging/crop Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_cropped_image_async POST /imaging/crop Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_deskewed_image POST /imaging/deskew Deskew an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_deskewed_image_async POST /imaging/deskew Deskew an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_fax_tiff POST /imaging/tiff/toFax Update parameters of TIFF image accordingly to fax parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_fax_tiff_async POST /imaging/tiff/toFax Update parameters of TIFF image accordingly to fax parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_folder PUT /imaging/storage/folder/{path} Create the folder
ImagingApi create_folder_async PUT /imaging/storage/folder/{path} Create the folder
ImagingApi create_grayscaled_image POST /imaging/grayscale Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_grayscaled_image_async POST /imaging/grayscale Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_features POST /imaging/ai/imageSearch/{searchContextId}/features Extract images features and add them to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_features_async POST /imaging/ai/imageSearch/{searchContextId}/features Extract images features and add them to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_frame POST /imaging/frames/{frameId} Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_frame_async POST /imaging/frames/{frameId} Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_frame_range POST /imaging/frames/range Get frames range from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_frame_range_async POST /imaging/frames/range Get frames range from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_search POST /imaging/ai/imageSearch/create Create new search context.
ImagingApi create_image_search_async POST /imaging/ai/imageSearch/create Create new search context.
ImagingApi create_image_tag POST /imaging/ai/imageSearch/{searchContextId}/addTag Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_image_tag_async POST /imaging/ai/imageSearch/{searchContextId}/addTag Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_bmp POST /imaging/bmp Update parameters of BMP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_bmp_async POST /imaging/bmp Update parameters of BMP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_emf POST /imaging/emf Process existing EMF imaging using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_emf_async POST /imaging/emf Process existing EMF imaging using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_gif POST /imaging/gif Update parameters of GIF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_gif_async POST /imaging/gif Update parameters of GIF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_jpeg POST /imaging/jpg Update parameters of JPEG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_jpeg_async POST /imaging/jpg Update parameters of JPEG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_jpeg2000 POST /imaging/jpg2000 Update parameters of JPEG2000 image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_jpeg2000_async POST /imaging/jpg2000 Update parameters of JPEG2000 image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_psd POST /imaging/psd Update parameters of PSD image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_psd_async POST /imaging/psd Update parameters of PSD image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_svg POST /imaging/svg Update parameters of SVG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_svg_async POST /imaging/svg Update parameters of SVG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_tiff POST /imaging/tiff Update parameters of TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_tiff_async POST /imaging/tiff Update parameters of TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_web_p POST /imaging/webp Update parameters of WEBP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_web_p_async POST /imaging/webp Update parameters of WEBP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_wmf POST /imaging/wmf Process existing WMF image using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_modified_wmf_async POST /imaging/wmf Process existing WMF image using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_object_bounds POST /imaging/ai/objectdetection/bounds Detects objects bounds. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_object_bounds_async POST /imaging/ai/objectdetection/bounds Detects objects bounds. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_resized_image POST /imaging/resize Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_resized_image_async POST /imaging/resize Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_rotate_flipped_image POST /imaging/rotateflip Rotate and/or flip an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_rotate_flipped_image_async POST /imaging/rotateflip Rotate and/or flip an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_updated_image POST /imaging/updateImage Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_updated_image_async POST /imaging/updateImage Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi create_visual_object_bounds POST /imaging/ai/objectdetection/visualbounds Detects objects bounds and draw them on the original image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream
ImagingApi create_visual_object_bounds_async POST /imaging/ai/objectdetection/visualbounds Detects objects bounds and draw them on the original image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream
ImagingApi create_web_site_image_features POST /imaging/ai/imageSearch/{searchContextId}/features/web Extract images features from web page and add them to search context
ImagingApi create_web_site_image_features_async POST /imaging/ai/imageSearch/{searchContextId}/features/web Extract images features from web page and add them to search context
ImagingApi crop_image GET /imaging/{name}/crop Crop an existing image.
ImagingApi crop_image_async GET /imaging/{name}/crop Crop an existing image.
ImagingApi delete_file DELETE /imaging/storage/file/{path} Delete file
ImagingApi delete_file_async DELETE /imaging/storage/file/{path} Delete file
ImagingApi delete_folder DELETE /imaging/storage/folder/{path} Delete folder
ImagingApi delete_folder_async DELETE /imaging/storage/folder/{path} Delete folder
ImagingApi delete_image_features DELETE /imaging/ai/imageSearch/{searchContextId}/features Deletes image features from search context.
ImagingApi delete_image_features_async DELETE /imaging/ai/imageSearch/{searchContextId}/features Deletes image features from search context.
ImagingApi delete_image_search DELETE /imaging/ai/imageSearch/{searchContextId} Deletes the search context.
ImagingApi delete_image_search_async DELETE /imaging/ai/imageSearch/{searchContextId} Deletes the search context.
ImagingApi delete_search_image DELETE /imaging/ai/imageSearch/{searchContextId}/image Delete image and images features from search context
ImagingApi delete_search_image_async DELETE /imaging/ai/imageSearch/{searchContextId}/image Delete image and images features from search context
ImagingApi deskew_image GET /imaging/{name}/deskew Deskew an existing image.
ImagingApi deskew_image_async GET /imaging/{name}/deskew Deskew an existing image.
ImagingApi download_file GET /imaging/storage/file/{path} Download file
ImagingApi download_file_async GET /imaging/storage/file/{path} Download file
ImagingApi extract_image_features GET /imaging/ai/imageSearch/{searchContextId}/image2features Extract features from image without adding to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi extract_image_features_async GET /imaging/ai/imageSearch/{searchContextId}/image2features Extract features from image without adding to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi extract_image_frame_properties POST /imaging/frames/{frameId}/properties Get separate frame properties of existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi extract_image_frame_properties_async POST /imaging/frames/{frameId}/properties Get separate frame properties of existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi extract_image_properties POST /imaging/properties Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi extract_image_properties_async POST /imaging/properties Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi filter_effect_image PUT /imaging/{name}/filterEffect Apply filtering effects to an existing image.
ImagingApi filter_effect_image_async PUT /imaging/{name}/filterEffect Apply filtering effects to an existing image.
ImagingApi find_image_duplicates GET /imaging/ai/imageSearch/{searchContextId}/findDuplicates Find images duplicates.
ImagingApi find_image_duplicates_async GET /imaging/ai/imageSearch/{searchContextId}/findDuplicates Find images duplicates.
ImagingApi find_images_by_tags POST /imaging/ai/imageSearch/{searchContextId}/findByTags Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi find_images_by_tags_async POST /imaging/ai/imageSearch/{searchContextId}/findByTags Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi find_similar_images GET /imaging/ai/imageSearch/{searchContextId}/findSimilar Find similar images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi find_similar_images_async GET /imaging/ai/imageSearch/{searchContextId}/findSimilar Find similar images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi get_available_labels GET /imaging/ai/objectdetection/availablelabels/{method} Gets available labels for selected object detection method.
ImagingApi get_available_labels_async GET /imaging/ai/objectdetection/availablelabels/{method} Gets available labels for selected object detection method.
ImagingApi get_disc_usage GET /imaging/storage/disc Get disc usage
ImagingApi get_disc_usage_async GET /imaging/storage/disc Get disc usage
ImagingApi get_file_versions GET /imaging/storage/version/{path} Get file versions
ImagingApi get_file_versions_async GET /imaging/storage/version/{path} Get file versions
ImagingApi get_files_list GET /imaging/storage/folder/{path} Get all files and folders within a folder
ImagingApi get_files_list_async GET /imaging/storage/folder/{path} Get all files and folders within a folder
ImagingApi get_image_features GET /imaging/ai/imageSearch/{searchContextId}/features Gets image features from search context.
ImagingApi get_image_features_async GET /imaging/ai/imageSearch/{searchContextId}/features Gets image features from search context.
ImagingApi get_image_frame GET /imaging/{name}/frames/{frameId} Get separate frame from existing image.
ImagingApi get_image_frame_async GET /imaging/{name}/frames/{frameId} Get separate frame from existing image.
ImagingApi get_image_frame_properties GET /imaging/{name}/frames/{frameId}/properties Get separate frame properties of existing image.
ImagingApi get_image_frame_properties_async GET /imaging/{name}/frames/{frameId}/properties Get separate frame properties of existing image.
ImagingApi get_image_frame_range GET /imaging/{name}/frames/range Get frames range from existing image.
ImagingApi get_image_frame_range_async GET /imaging/{name}/frames/range Get frames range from existing image.
ImagingApi get_image_properties GET /imaging/{name}/properties Get properties of an image.
ImagingApi get_image_properties_async GET /imaging/{name}/properties Get properties of an image.
ImagingApi get_image_search_status GET /imaging/ai/imageSearch/{searchContextId}/status Gets the search context status.
ImagingApi get_image_search_status_async GET /imaging/ai/imageSearch/{searchContextId}/status Gets the search context status.
ImagingApi get_object_bounds GET /imaging/ai/objectdetection/{name}/bounds Detects objects' bounds
ImagingApi get_object_bounds_async GET /imaging/ai/objectdetection/{name}/bounds Detects objects' bounds
ImagingApi get_search_image GET /imaging/ai/imageSearch/{searchContextId}/image Get image from search context
ImagingApi get_search_image_async GET /imaging/ai/imageSearch/{searchContextId}/image Get image from search context
ImagingApi get_visual_object_bounds GET /imaging/ai/objectdetection/{name}/visualbounds Detects objects bounds and draw them on the original image
ImagingApi get_visual_object_bounds_async GET /imaging/ai/objectdetection/{name}/visualbounds Detects objects bounds and draw them on the original image
ImagingApi grayscale_image GET /imaging/{name}/grayscale Grayscale an existing image.
ImagingApi grayscale_image_async GET /imaging/{name}/grayscale Grayscale an existing image.
ImagingApi modify_bmp GET /imaging/{name}/bmp Update parameters of existing BMP image.
ImagingApi modify_bmp_async GET /imaging/{name}/bmp Update parameters of existing BMP image.
ImagingApi modify_emf GET /imaging/{name}/emf Process existing EMF imaging using given parameters.
ImagingApi modify_emf_async GET /imaging/{name}/emf Process existing EMF imaging using given parameters.
ImagingApi modify_gif GET /imaging/{name}/gif Update parameters of existing GIF image.
ImagingApi modify_gif_async GET /imaging/{name}/gif Update parameters of existing GIF image.
ImagingApi modify_jpeg GET /imaging/{name}/jpg Update parameters of existing JPEG image.
ImagingApi modify_jpeg_async GET /imaging/{name}/jpg Update parameters of existing JPEG image.
ImagingApi modify_jpeg2000 GET /imaging/{name}/jpg2000 Update parameters of existing JPEG2000 image.
ImagingApi modify_jpeg2000_async GET /imaging/{name}/jpg2000 Update parameters of existing JPEG2000 image.
ImagingApi modify_psd GET /imaging/{name}/psd Update parameters of existing PSD image.
ImagingApi modify_psd_async GET /imaging/{name}/psd Update parameters of existing PSD image.
ImagingApi modify_svg GET /imaging/{name}/svg Update parameters of existing SVG image.
ImagingApi modify_svg_async GET /imaging/{name}/svg Update parameters of existing SVG image.
ImagingApi modify_tiff GET /imaging/{name}/tiff Update parameters of existing TIFF image.
ImagingApi modify_tiff_async GET /imaging/{name}/tiff Update parameters of existing TIFF image.
ImagingApi modify_web_p GET /imaging/{name}/webp Update parameters of existing WEBP image.
ImagingApi modify_web_p_async GET /imaging/{name}/webp Update parameters of existing WEBP image.
ImagingApi modify_wmf GET /imaging/{name}/wmf Process existing WMF image using given parameters.
ImagingApi modify_wmf_async GET /imaging/{name}/wmf Process existing WMF image using given parameters.
ImagingApi move_file PUT /imaging/storage/file/move/{srcPath} Move file
ImagingApi move_file_async PUT /imaging/storage/file/move/{srcPath} Move file
ImagingApi move_folder PUT /imaging/storage/folder/move/{srcPath} Move folder
ImagingApi move_folder_async PUT /imaging/storage/folder/move/{srcPath} Move folder
ImagingApi object_exists GET /imaging/storage/exist/{path} Check if file or folder exists
ImagingApi object_exists_async GET /imaging/storage/exist/{path} Check if file or folder exists
ImagingApi resize_image GET /imaging/{name}/resize Resize an existing image.
ImagingApi resize_image_async GET /imaging/{name}/resize Resize an existing image.
ImagingApi rotate_flip_image GET /imaging/{name}/rotateflip Rotate and/or flip an existing image.
ImagingApi rotate_flip_image_async GET /imaging/{name}/rotateflip Rotate and/or flip an existing image.
ImagingApi storage_exists GET /imaging/storage/{storageName}/exist Check if storage exists
ImagingApi storage_exists_async GET /imaging/storage/{storageName}/exist Check if storage exists
ImagingApi update_image GET /imaging/{name}/updateImage Perform scaling, cropping and flipping of an existing image in a single request.
ImagingApi update_image_async GET /imaging/{name}/updateImage Perform scaling, cropping and flipping of an existing image in a single request.
ImagingApi update_image_features PUT /imaging/ai/imageSearch/{searchContextId}/features Update images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi update_image_features_async PUT /imaging/ai/imageSearch/{searchContextId}/features Update images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi update_search_image PUT /imaging/ai/imageSearch/{searchContextId}/image Update image and images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi update_search_image_async PUT /imaging/ai/imageSearch/{searchContextId}/image Update image and images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
ImagingApi upload_file PUT /imaging/storage/file/{path} Upload file
ImagingApi upload_file_async PUT /imaging/storage/file/{path} Upload file

Documentation for Models