PIpicsart
Content Generation

Pattern Generator

Changed on

The pattern generator tool generates a background texture pattern for the input image. You can create unlimited patterns from the same source image.

post/background/pattern

Request

  • Base URL
    https://api.picsart.io/tools/1.0
  • URL
    https://api.picsart.io/tools/1.0/background/pattern
  • Auth
    API key in header X-Picsart-API-Key

Request body multipart/form-data

imagestring binary

Source image file (binary). (If this parameter is present, the other image source parameters must be empty.)

image_urlstring uri

Source image URL. (If this parameter is present, the other image source parameters must be empty.)

image_idstring

Deprecated. Source image ID of an image previously uploaded to Picsart or result image ID from a different API. (If this parameter is present, the other image source parameters must be empty.)

format'JPG' | 'PNG' | 'WEBP'

Optionally select one of the image formats (JPG is chosen if left blank). Options are as follows:

  • JPG
  • PNG
  • WEBP
widthinteger

Specify the width of the output image in pixels. The default is 1024 and the maximum acceptable value is 8000.

heightinteger

Specify the height of the output image in pixels. The default is 1024 and the maximum acceptable value is 8000.

offset_xinteger

Specify the pattern location, with x(width). Calculation starts from the center of the image. Default is 0.

offset_yinteger

Specify the pattern location with y(height). Calculation starts from the center of the image. Default is 0.

pattern'hex' | 'mirror' | 'diamond' | 'hex2' | 'tile'

Choose a pattern for the background texture. Default is hex.

rotateinteger

Enter an integer value to rotate the texture pattern from -180 to +180. Default is 0.

scalenumber float

Enter a floating point number between 0.5 - 10.0 to scale the background texture. Default is 1.0.

Response

Success.

statusstring

Changes

  • 466238206997Revision changes
    • warning

      the optional response header X-Correlation-Id removed for the status 400

    • warning

      the optional response header X-Correlation-Id removed for the status 401

    • warning

      the optional response header X-Correlation-Id removed for the status 403

    • warning

      the optional response header X-Correlation-Id removed for the status 404

    • warning

      the optional response header X-Correlation-Id removed for the status 405

    • warning

      the optional response header X-Correlation-Id removed for the status 413

    • warning

      the optional response header X-Correlation-Id removed for the status 415

    • warning

      the optional response header X-Correlation-Id removed for the status 429

    • warning

      the optional response header X-Correlation-Id removed for the status 431

    • warning

      the optional response header X-Correlation-Id removed for the status 500

    • warning

      the optional response header X-Correlation-Id removed for the status 503

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property ////

    • info

      added the non-success response with the status