Image Composition - Stitch Images

Service:

Azure AI Services

API Version:

2023-04-01-preview

Run the image stitching operation against a sequence of images.

POST /imagecomposition:stitch?api-version=2023-04-01-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Requested API version.

Request Body

Media Types: "application/json-patch+json"

Name	Required	Type	Description
images	True	string[]	Source images to stitch.

Responses

Name	Type	Description
200 OK	file	Success Media Types: "image/jpeg", "application/json"
Other Status Codes	ErrorResponse	Error Media Types: "image/jpeg", "application/json" Headers x-ms-error-code: string

Examples

ImageComposition_Stitch

Sample request

HTTP

POST /imagecomposition:stitch?api-version=2023-04-01-preview

{
  "images": [
    "https://example.com/image-1.jpg",
    "https://example.com/image-2.jpg",
    "https://example.com/image-3.jpg",
    "https://example.com/image-4.jpg",
    "https://example.com/image-5.jpg"
  ]
}

Sample response

Status code:

200

"Ynl0ZXM="

Definitions

Name	Description
ErrorResponse	Response returned when an error occurs.
ErrorResponseDetails	Error info.
ErrorResponseInnerError	Detailed error.
ImageStitchingRequestApiModel	Image stitching input.

ErrorResponse

Response returned when an error occurs.

Name	Type	Description
error	ErrorResponseDetails	Error info.

ErrorResponseDetails

Error info.

Name	Type	Description
code	string	Error code.
details	ErrorResponseDetails[]	List of detailed errors.
innererror	ErrorResponseInnerError	Detailed error.
message	string	Error message.
target	string	Target of the error.

ErrorResponseInnerError

Detailed error.

Name	Type	Description
code	string	Error code.
innererror	ErrorResponseInnerError	Detailed error.
message	string	Error message.

ImageStitchingRequestApiModel

Image stitching input.

Name	Type	Description
images	string[]	Source images to stitch.