Class PhotoshopSdk

constructor

• new PhotoshopSdk(args?: { client?: Client; key?: string }): PhotoshopSdk

  Parameters

  • Optionalargs: { client?: Client; key?: string }

  Returns PhotoshopSdk

Static Readonly__registry

applyAutoCropAsync

• applyAutoCropAsync<ThrowOnError extends boolean = false>(
      options: Options<ApplyAutoCropAsyncData, ThrowOnError>,
  ): RequestResult<
      ApplyAutoCropAsyncResponses,
      ApplyAutoCropAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Product crop

  This endpoint identifies the subject of the input file and automatically crops the image to keep the subject in the center. Check the status of this process with the Get Status endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ApplyAutoCropAsyncData, ThrowOnError>

  Returns RequestResult<
      ApplyAutoCropAsyncResponses,
      ApplyAutoCropAsyncErrors,
      ThrowOnError,
      "fields",
  >

applyDepthBlurAsync

• applyDepthBlurAsync<ThrowOnError extends boolean = false>(
      options: Options<ApplyDepthBlurAsyncData, ThrowOnError>,
  ): RequestResult<
      ApplyDepthBlurAsyncResponses,
      ApplyDepthBlurAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Depth blur

  Apply depth blur to an image input.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ApplyDepthBlurAsyncData, ThrowOnError>

  Returns RequestResult<
      ApplyDepthBlurAsyncResponses,
      ApplyDepthBlurAsyncErrors,
      ThrowOnError,
      "fields",
  >

convertToActionsJsonAsync

• convertToActionsJsonAsync<ThrowOnError extends boolean = false>(
      options: Options<ConvertToActionsJsonAsyncData, ThrowOnError>,
  ): RequestResult<
      ConvertToActionsJsonAsyncResponses,
      ConvertToActionsJsonAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Convert to actionJSON

  Convert an ATN file to actionJSON format.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ConvertToActionsJsonAsyncData, ThrowOnError>

  Returns RequestResult<
      ConvertToActionsJsonAsyncResponses,
      ConvertToActionsJsonAsyncErrors,
      ThrowOnError,
      "fields",
  >

createArtboardAsync

• createArtboardAsync<ThrowOnError extends boolean = false>(
      options: Options<CreateArtboardAsyncData, ThrowOnError>,
  ): RequestResult<
      CreateArtboardAsyncResponses,
      CreateArtboardAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Create artboards

  Create artboards from multiple PSD inputs.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<CreateArtboardAsyncData, ThrowOnError>

  Returns RequestResult<
      CreateArtboardAsyncResponses,
      CreateArtboardAsyncErrors,
      ThrowOnError,
      "fields",
  >

createDocumentAsync

• createDocumentAsync<ThrowOnError extends boolean = false>(
      options: Options<CreateDocumentAsyncData, ThrowOnError>,
  ): RequestResult<
      CreateDocumentAsyncResponses,
      CreateDocumentAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Create PSD

  Create new PSD with layers.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<CreateDocumentAsyncData, ThrowOnError>

  Returns RequestResult<
      CreateDocumentAsyncResponses,
      CreateDocumentAsyncErrors,
      ThrowOnError,
      "fields",
  >

createMaskAsync

• createMaskAsync<ThrowOnError extends boolean = false>(
      options: Options<CreateMaskAsyncData, ThrowOnError>,
  ): RequestResult<
      CreateMaskAsyncResponses,
      CreateMaskAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Create mask

  ⚠️ DEPRECATED: This endpoint is deprecated and will no longer be accessible after Oct 15, 2025. Use /v2/remove-background instead. For more information, see the Deprecation Announcement.This endpoint uses the Remove Background AI/ML model to return a PNG file with a mask applied around the subject. To check the status of this process, utilize the Get Status - Mask endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<CreateMaskAsyncData, ThrowOnError>

  Returns RequestResult<
      CreateMaskAsyncResponses,
      CreateMaskAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Deprecated

createRenditionAsync

• createRenditionAsync<ThrowOnError extends boolean = false>(
      options: Options<CreateRenditionAsyncData, ThrowOnError>,
  ): RequestResult<
      CreateRenditionAsyncResponses,
      CreateRenditionAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Create renditions

  Create flat image representations of a PSD in multiple formats.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<CreateRenditionAsyncData, ThrowOnError>

  Returns RequestResult<
      CreateRenditionAsyncResponses,
      CreateRenditionAsyncErrors,
      ThrowOnError,
      "fields",
  >

editTextLayerAsync

• editTextLayerAsync<ThrowOnError extends boolean = false>(
      options: Options<EditTextLayerAsyncData, ThrowOnError>,
  ): RequestResult<
      EditTextLayerAsyncResponses,
      EditTextLayerAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Edit text layer

  Change the contents of a text layer in a PSD, e.g. for localization.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<EditTextLayerAsyncData, ThrowOnError>

  Returns RequestResult<
      EditTextLayerAsyncResponses,
      EditTextLayerAsyncErrors,
      ThrowOnError,
      "fields",
  >

facadeJobStatus

• facadeJobStatus<ThrowOnError extends boolean = false>(
      options: Options<FacadeJobStatusData, ThrowOnError>,
  ): RequestResult<
      FacadeJobStatusResponses,
      FacadeJobStatusErrors,
      ThrowOnError,
      "fields",
  >

  Get status - v2

  Retrieve the status of a running Remove Background job by providing the job ID. The job ID is obtained from the response of the asynchronous Remove Background API call.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<FacadeJobStatusData, ThrowOnError>

  Returns RequestResult<
      FacadeJobStatusResponses,
      FacadeJobStatusErrors,
      ThrowOnError,
      "fields",
  >

fillMaskedAreas

• fillMaskedAreas<ThrowOnError extends boolean = false>(
      options: Options<FillMaskedAreasData, ThrowOnError>,
  ): RequestResult<
      FillMaskedAreasResponses,
      FillMaskedAreasErrors,
      ThrowOnError,
      "fields",
  >

  Fill masked areas

  This endpoint allows you to inpaint masked areas within an image. The API will remove the objects represented by these masks and inpaint the specified areas. Provide a list of masks corresponding to the regions you wish to modify. To check the status of this process, utilize the Get Status - V1 endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<FillMaskedAreasData, ThrowOnError>

  Returns RequestResult<
      FillMaskedAreasResponses,
      FillMaskedAreasErrors,
      ThrowOnError,
      "fields",
  >

getDocumentManifestAsync

• getDocumentManifestAsync<ThrowOnError extends boolean = false>(
      options: Options<GetDocumentManifestAsyncData, ThrowOnError>,
  ): RequestResult<
      GetDocumentManifestAsyncResponses,
      GetDocumentManifestAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Extract document manifest

  Extract metadata from PSD document, including general file and layer information.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetDocumentManifestAsyncData, ThrowOnError>

  Returns RequestResult<
      GetDocumentManifestAsyncResponses,
      GetDocumentManifestAsyncErrors,
      ThrowOnError,
      "fields",
  >

getJobStatus

• getJobStatus<ThrowOnError extends boolean = false>(
      options: Options<GetJobStatusData, ThrowOnError>,
  ): RequestResult<
      GetJobStatusResponses,
      GetJobStatusErrors,
      ThrowOnError,
      "fields",
  >

  Get status - v1

  This endpoint allows you to check the status of an asynchronous job for a masking operation. The schema of a 200 response varies depending on the status of the job. A job with a succeeded status will include the results in the response and the result objects vary depending on the operation.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetJobStatusData, ThrowOnError>

  Returns RequestResult<GetJobStatusResponses, GetJobStatusErrors, ThrowOnError, "fields">

maskBodyParts

• maskBodyParts<ThrowOnError extends boolean = false>(
      options: Options<MaskBodyPartsData, ThrowOnError>,
  ): RequestResult<
      MaskBodyPartsResponses,
      MaskBodyPartsErrors,
      ThrowOnError,
      "fields",
  >

  Generate human item masks

  This endpoint processes an input image of a human, then identifies and creates masks for various items and sections on the body including sunglasses, hats, upper body apparel, lower body apparel, left arm, right arm, and more. The API returns an array of masks corresponding to each detected item and body part. To check the status of this process, utilize the Get Status - V1 endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<MaskBodyPartsData, ThrowOnError>

  Returns RequestResult<
      MaskBodyPartsResponses,
      MaskBodyPartsErrors,
      ThrowOnError,
      "fields",
  >

maskObjects

• maskObjects<ThrowOnError extends boolean = false>(
      options: Options<MaskObjectsData, ThrowOnError>,
  ): RequestResult<
      MaskObjectsResponses,
      MaskObjectsErrors,
      ThrowOnError,
      "fields",
  >

  Generate object and background masks

  Given an image, this API generates semantic masks for the foreground objects and a list of background masks that segment the background elements of the image. Each mask includes a label and a URL for the mask image. To check the status of this process, utilize the Get Status - V1 endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<MaskObjectsData, ThrowOnError>

  Returns RequestResult<MaskObjectsResponses, MaskObjectsErrors, ThrowOnError, "fields">

modifyDocumentAsync

• modifyDocumentAsync<ThrowOnError extends boolean = false>(
      options: Options<ModifyDocumentAsyncData, ThrowOnError>,
  ): RequestResult<
      ModifyDocumentAsyncResponses,
      ModifyDocumentAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Apply photoshop edits

  Apply basic layer edits (name, state, etc.), add/edit adjustment, pixel, and shape layers.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ModifyDocumentAsyncData, ThrowOnError>

  Returns RequestResult<
      ModifyDocumentAsyncResponses,
      ModifyDocumentAsyncErrors,
      ThrowOnError,
      "fields",
  >

playPhotoshopActionsAsync

• playPhotoshopActionsAsync<ThrowOnError extends boolean = false>(
      options: Options<PlayPhotoshopActionsAsyncData, ThrowOnError>,
  ): RequestResult<
      PlayPhotoshopActionsAsyncResponses,
      PlayPhotoshopActionsAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Run photoshop actions

  Executes Photoshop Action file against a PSD, JPEG, PNG, or TIFF.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<PlayPhotoshopActionsAsyncData, ThrowOnError>

  Returns RequestResult<
      PlayPhotoshopActionsAsyncResponses,
      PlayPhotoshopActionsAsyncErrors,
      ThrowOnError,
      "fields",
  >

playPhotoshopActionsJsonAsync

• playPhotoshopActionsJsonAsync<ThrowOnError extends boolean = false>(
      options: Options<PlayPhotoshopActionsJsonAsyncData, ThrowOnError>,
  ): RequestResult<
      PlayPhotoshopActionsJsonAsyncResponses,
      PlayPhotoshopActionsJsonAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Run actionJSON

  Execute given Photoshop Action specified in actionJSON format.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<PlayPhotoshopActionsJsonAsyncData, ThrowOnError>

  Returns RequestResult<
      PlayPhotoshopActionsJsonAsyncResponses,
      PlayPhotoshopActionsJsonAsyncErrors,
      ThrowOnError,
      "fields",
  >

psJobStatus

• psJobStatus<ThrowOnError extends boolean = false>(
      options: Options<PsJobStatusData, ThrowOnError>,
  ): RequestResult<PsJobStatusResponses, unknown, ThrowOnError, "fields">

  Get status

  Get the job status of a Photoshop job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<PsJobStatusData, ThrowOnError>

  Returns RequestResult<PsJobStatusResponses, unknown, ThrowOnError, "fields">

refineMask

• refineMask<ThrowOnError extends boolean = false>(
      options: Options<RefineMaskData, ThrowOnError>,
  ): RequestResult<
      RefineMaskResponses,
      RefineMaskErrors,
      ThrowOnError,
      "fields",
  >

  Refine mask

  This endpoint allows you to refine and improve the quality of existing masks. The API will enhance the edges and details of the provided masks to create more precise and accurate results. To check the status of this process, utilize the Get Status - V1 endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<RefineMaskData, ThrowOnError>

  Returns RequestResult<RefineMaskResponses, RefineMaskErrors, ThrowOnError, "fields">

removeBackground

• removeBackground<ThrowOnError extends boolean = false>(
      options: Options<RemoveBackgroundData, ThrowOnError>,
  ): RequestResult<
      RemoveBackgroundResponses,
      RemoveBackgroundErrors,
      ThrowOnError,
      "fields",
  >

  Remove background v2

  This endpoint allows you to remove the background from an image. The request is processed asynchronously and the status of the running job can be checked with the Get Status endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<RemoveBackgroundData, ThrowOnError>

  Returns RequestResult<
      RemoveBackgroundResponses,
      RemoveBackgroundErrors,
      ThrowOnError,
      "fields",
  >

removeBackgroundAsync

• removeBackgroundAsync<ThrowOnError extends boolean = false>(
      options: Options<RemoveBackgroundAsyncData, ThrowOnError>,
  ): RequestResult<
      RemoveBackgroundAsyncResponses,
      RemoveBackgroundAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Remove background v1 (Deprecated)

  ⚠️ DEPRECATED: This endpoint is deprecated and will no longer be accessible after Oct 15, 2025. Use /v2/remove-background instead. For more information, see the Deprecation Announcement. This endpoint will identify the main subject of your image and removes the background automatically. It also provides options to return a PNG file in 4 channel RGBA or 3 channel RGB format. To check the status of this process, utilize the Get Status - Mask endpoint.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<RemoveBackgroundAsyncData, ThrowOnError>

  Returns RequestResult<
      RemoveBackgroundAsyncResponses,
      RemoveBackgroundAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Deprecated

replaceSmartObjectAsync

• replaceSmartObjectAsync<ThrowOnError extends boolean = false>(
      options: Options<ReplaceSmartObjectAsyncData, ThrowOnError>,
  ): RequestResult<
      ReplaceSmartObjectAsyncResponses,
      ReplaceSmartObjectAsyncErrors,
      ThrowOnError,
      "fields",
  >

  Replace smart object

  Replace Smart Object in a PSD.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ReplaceSmartObjectAsyncData, ThrowOnError>

  Returns RequestResult<
      ReplaceSmartObjectAsyncResponses,
      ReplaceSmartObjectAsyncErrors,
      ThrowOnError,
      "fields",
  >

senseiJobStatus

• senseiJobStatus<ThrowOnError extends boolean = false>(
      options: Options<SenseiJobStatusData, ThrowOnError>,
  ): RequestResult<SenseiJobStatusResponses, unknown, ThrowOnError, "fields">

  Get status - mask

  This endpoint returns the status of a job for a Remove Background and Create Mask operation. The schema of a 200 response varies depending on the status of the job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<SenseiJobStatusData, ThrowOnError>

  Returns RequestResult<SenseiJobStatusResponses, unknown, ThrowOnError, "fields">