Add a Picture to an Excel Worksheet – Aspose.Cells Cloud API

This REST API adds a new picture to an Excel worksheet.
Prerequisites: You must have a valid Aspose Cloud authentication token, an existing workbook stored in a supported storage, and appropriate permissions to modify the worksheet.

PutWorksheetAddPicture API

PUT https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/pictures

Security and Authentication

The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.

Request Parameters

Parameter Name Type Location Description
name string path The workbook name.
sheetName string path The worksheet name.
picture object body Picture object (binary data).
upperLeftRow integer query Zero‑based index of the upper‑left row where the picture will be placed.
upperLeftColumn integer query Zero‑based index of the upper‑left column where the picture will be placed.
lowerRightRow integer query Zero‑based index of the lower‑right row of the picture area.
lowerRightColumn integer query Zero‑based index of the lower‑right column of the picture area.
picturePath string query Path to the picture file; if omitted, the picture data must be supplied in the request body.
folder string query The folder that contains the workbook.
storageName string query The name of the storage service.

Request Body Note: When picturePath is omitted, send the binary image data in the request body using multipart/form-data.

HTTP Status Codes

Code Meaning Description
200 OK Filter applied successfully; response contains operation details.
400 Bad Request Missing or invalid parameters (e.g., unsupported file type).
401 Unauthorized Invalid or missing JWT token.
413 Payload Too Large Uploaded file exceeds size limit.
500 Internal Server Error Unexpected server error.

Example 200 Response Schema

{
  "Code": 200,
  "Status": "OK",
  "PictureUrl": "https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/pictures/1"
}

Note: The maximum picture size is 10 MB; larger files will be rejected with a 400 Bad Request response.

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make calls to the Cloud API with cURL.

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles low‑level details so you can focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to make calls to Aspose.Cells web services using various SDKs:

Note: Supported image formats include PNG, JPEG, BMP, and GIF. Maximum picture size is 10 MB; larger files will be rejected with a 400 Bad Request response.