WriteText.ai API - Upload an image

Requirements

Authentication Required

Bearer access_token

Request Headers

Authorization: Bearer access_token

Parameter Name	Type	Description
storeId	string, required	A string representing the storefront. This helps differentiate between images in different stores.
imageId	string, required	A unique string identifier for the image. This can be any string and will be used to reference the image in future API calls.
url	string, optional	The public URL of the image. If the image is already hosted online and publicly accessible, this can be used instead of uploading the image directly.
imageData	string, optional	The base64-encoded image data. This is required if the image is not publicly accessible via a URL. Supported MIME types include: image/jpg image/png image/gif image/svg+xml image/webp Sample format: data:image/jpeg;base64,/9j....Akz//Z
ipAddress	string, required	The IP address of the client, often defaulted to ::1 for localhost.
overwrite	boolean, optional	If set to true, this will overwrite an existing image with the same imageId.

Response

200

400

404

500

//Returns the details of the uploaded image, including the public URL and metadata.

{"url": "https://.../e18addbc-3475-01b2-bd7c-5028b2ce2b6e.png","imageId": "d35grtsz-4906-13d4-sa5g-3405b2ce4b9e","lastModified": "2024-09-06T03:34:35.234Z","imageDataExpires": "2024-10-06T03:34:35.234Z"}

//If the request contains invalid parameters or if the image format is unsupported.

{<br>    "error": "Invalid request parameters",<br>    "code": 400<br>}

//If the image specified by imageId cannot be found or is invalid.

//The server encountered an error when processing the request.