The Styldod Order APIs are designed to provide seamless integration and functionality for developers. Our APIs follow a RESTful architecture, offering predictable and resource-oriented URLs for easy navigation and interaction. Request bodies are encoded using the standard form-encoded format, and responses are returned in JSON, making data manipulation and interpretation straightforward. This API also allows you to place orders programmatically, and these orders will be visible on the Styldod user dashboard as well.
\nAuthentication and security are paramount, and our API employs standard HTTP response codes, authentication mechanisms, and HTTP verbs to ensure secure and reliable communication. We currently support an API key-based authentication method for API requests.
\nFor any help regarding the API, please contact us at help@styldod.com.
\nThe service endpoint for all Styldod Order APIs and all URLs mentioned in this document are relative to these service endpoint:
\nProduction URL:
\n\n\n\n
BASE_URL: https://orderapi.styldod.com
For testing purpose, please use the UAT (User Acceptance Testing) URL
\n\n\n\n
BASE_URL: https://uat-orderapi.styldod.com
The Styldod Order APIs utilize API keys for authentication purposes. These API keys act as a secure means of verifying and authorizing requests made to the API.
\nIt is very important to handle your API keys with care and keep them secure at all times.
\nAPI keys grant access to API calls that may retrieve or change your data and/or may lead to incurring significant charges. It is therefore important that these keys keep them secured at all times to prevent them from being used by unauthorized users. Avoid sharing your Styldod Order API keys in publicly accessible areas such as version control repositories like GitHub or client-side code that can be accessed by others.
\nTo authenticate your API requests, include the API key in the header as follows:
\napi-key : {{API-KEY}}
All Styldod Order APIs have a rate limit of 20 requests per second. Exceeding this rate limit will result in 429 (Too Many Requests) HTTP errors.
\nStyldod Order APIs uses common HTTP response status codes to indicate the success or failure of these API requests.
\nFollowing is the list of HTTP status codes:
\nIf you don't have your own storage you can upload binary image files to our S3 bucket on AWS. Before placing an order, you must upload the images you want to edit. This is done using the Get Upload URLs API:
\nGet Pre-Signed URLs:
\nStart by calling the Get Upload URLs API to obtain pre-signed URLs for your images.
\nThe API will return a set of secure, time-limited pre-signed URLs, which are valid for 4 hours.
\nUpload Images:
\nUse these pre-signed URLs to upload your images directly to the storage. Each URL corresponds to a specific image.
\nEnsure all images are successfully uploaded before proceeding to create the order.
\nUse the Uploaded Image URLs:
\nimage_urls field under image_list.During the order placement process or while creating an API key in the global configuration, you can specify a webhook URL, where you want to receive updates once your order is processed.
\nAfter processing your order, our system will send a POST request to the webhook URL you provided. This request will contain the order details, including order status, output image URLs, event, orderID and any relevant metadata.
\nBelow are webhook events for orders
\norder.completedorder.pre_processingorder.post_processingorder.expert_assignedorder.error
URL: The webhook URL must be provided during order placement.
\nHTTP Method: POST
\nResponse: The webhook must return a success response with an HTTP status code of 200 upon receiving the request. This confirms that the webhook has successfully processed the order details.
\n{\n \"event\": \"order.completed\",\n \"orderID\":\"1675563636373\",\n \"data\": {\n \"image_list\": [\n {\n \"client_image_id\": \"IMG#111\",\n \"image_status\": \"completed\",\n \"output_url\": \"https://www.example.com/image1.jpg\",\n \"sequence\": 1\n },\n {\n \"client_image_id\": \"IMG#222\",\n \"image_status\": \"completed\",\n \"output_url\": \"https://www.example.com/image2.jpg\",\n \"sequence\": 2\n },\n {\n \"client_image_id\": \"IMG#333\",\n \"image_status\": \"error\"\n },\n {\n \"client_image_id\": \"IMG#444\",\n \"image_status\": \"completed\",\n \"output_url\": \"https://www.example.com/image3.jpg\",\n \"sequence\": 3\n }\n ],\n \"order_status\": \"completed\",\n \"createdAt\": \"2024-08-21T09:13:48.156Z\",\n \"updatedAt\": \"2024-08-21T09:17:50.248Z\"\n }\n}\n\nIf the webhook fails to return a 200 status code, our system will retry the request up to 3 times at increasing intervals. If the webhook still does not respond successfully after these attempts, the order update may be considered failed.
\nEnsure that your webhook endpoint is correctly configured to handle the incoming POST request and respond with a 200 status code to avoid failed notifications.
\nGlobal config defines default settings for orders placed using the API. These settings are configured at the time of creating the API key and serve as the baseline configuration for all orders. The settings in this object are applied with the lowest precedence, meaning they can be overridden by settings specified at the order or individual image level.
\nThese settings include default image properties, webhook configurations, and contact information.
\nUsers can specify various options to orders at multiple levels, which are applied with different precedence. The options can be set in the following ways:
\nGlobal Configuration: These are default settings configured when creating the API key. If a options are set at this level, it will automatically apply to all requests unless overridden by the user.
\nApply to All (Order Level): Users can specify options that should apply to all images within a specific order with apply_to_all option. This is a convenient way to set common options for multiple images. However, these settings can be overridden at the image level.
Image Level: Options can be specified individually for each image within the image_list. This level has the highest precedence. If a option is set here, it will override both the global configuration and the apply_to_all settings.
Image Level: The highest priority. If a option is specified at this level, it takes precedence over any other settings.
\nApply to All: The second level of precedence. Options set here apply to all images unless overridden at the image level.
\nGlobal Configuration: The default settings that apply if no overrides are provided at the apply_to_all or image levels.
Consider the following scenario:
\nThe basic_editing option is set to true in the global configuration (API key level).
In the apply_to_all section of the request body, basic_editing is set to false.
For a specific image in the image_list, basic_editing is set to true.
In this case:
\nFor the specific image, basic_editing will be true (image level takes precedence).
For any other image where basic_editing is not explicitly set, it will be false (from apply_to_all).
If neither image level nor apply_to_all specifies basic_editing, it would default to true as per the global configuration.
This API is used to place a new order for image editing. To successfully place an order, you need to provide the necessary details in the request payload, including project information, image URLs, editing options, and delivery details.
\nproject_name (required): string
The name of the project.
maximum allowed 256 characters
webhook_url (optional): string
optional webhook callback URL, which can be used for receiving the final response when the job is completed or error details when it fails.
image_list (required): array
An array of objects each containing image URLs and editing options.
minimum required 1 image
image_urls (required): array
An array of URLs pointing to the images of different exposures to be merged.
minimum required 1 image
client_image_id (optional): string
A unique identifier for each image from the client side. This can be used by the client only for tracking the images. We will not use this for any other purpose.
comment (optional): string
A text field where the user can provide any additional instructions or comments for the editor. This could include specific requests or details to consider during the editing process. maximum allowed 1000 characters
basic_editing (optional): boolean
Flag indicating whether basic editing is applied.
hdr_merge (optional): boolean
Flag indicating whether HDR merging is applied.
sky_replacement (optional): boolean
Flag indicating whether sky replacement is applied.
lawn_replacement (optional): boolean
Flag indicating whether lawn replacement is applied.
tv_screen_replacement (optional): boolean
Flag indicating whether to replace the TV screen in the image with a different display or content.
add_fire_in_fireplace (optional): boolean
Flag indicating whether to digitally add a fire to the fireplace in the image.
remove_snow (optional): boolean
Flag indicating whether to remove snow from the image, making it appear as if the scene is snow-free.
blurring (optional): boolean
Flag indicating whether to apply a blurring effect to specific areas of the image, such as backgrounds or personal details.
object_removal (optional): boolean
Flag indicating whether to remove unwanted objects from the image.
occupied_to_vacant (optional): boolean
Flag indicating whether to digitally remove furniture and other items to make the space appear vacant.
day_to_dusk (optional): boolean
Flag indicating whether to transform a daytime image into a dusk or evening scene.
virtual_staging (optional): boolean
Flag indicating whether to add virtual furniture or décor to an empty or minimally furnished space in the image.
deliver_to_client (optional): boolean
Determines whether the final output should be delivered directly to the client. If set to true, the processed images or order details will be sent to the client's email specified in client_info.
client_info (optional): object
An object containing the client's contact information. This field is required if deliver_to_client is set to true
client_name (optional): string
The name of the client. Optional but recommended for personalized delivery.
maximum allowed 256 characters
client_email (required): string
The email address of the client. This is required for delivering the final output if deliver_to_client is set to true.
payment (optional): object
An object containing the order's payment information.
amount (required): number
The total amount of the payment.
currency (required): string
The currency in which the payment is made. It should follow the ISO 4217 standard. Example: INR (Indian Rupee)
status (optional): string
The current status of the payment.
date (optional): string
The date and time of the payment.
apply_to_all (optional): object
An object specifying default editing options to be applied to all images.
basic_editing (optional): boolean
Flag indicating whether basic editing is applied.
hdr_merge (optional): boolean
Flag indicating whether HDR merging is applied.
sky_replacement (optional): boolean
Flag indicating whether sky replacement is applied.
lawn_replacement (optional): boolean
Flag indicating whether lawn replacement is applied.
tv_screen_replacement (optional): boolean
Flag indicating whether to replace the TV screen in the image with a different display or content.
add_fire_in_fireplace (optional): boolean
Flag indicating whether to digitally add a fire to the fireplace in the image.
remove_snow (optional): boolean
Flag indicating whether to remove snow from the image, making it appear as if the scene is snow-free.
blurring (optional): boolean
Flag indicating whether to apply a blurring effect to specific areas of the image, such as backgrounds or personal details.
object_removal (optional): boolean
Flag indicating whether to remove unwanted objects from the image.
occupied_to_vacant (optional): boolean
Flag indicating whether to digitally remove furniture and other items to make the space appear vacant.
day_to_dusk (optional): boolean
Flag indicating whether to transform a daytime image into a dusk or evening scene.
virtual_staging (optional): boolean
Flag indicating whether to add virtual furniture or décor to an empty or minimally furnished space in the image.
This API allows you to update an existing order by replacing it with the new data provided in the request payload. The entire resource is overwritten with the new values, so all necessary fields must be included. The API identifies the resource to be updated based on a orderID and replaces the current resource with the updated data.
\nNote: Order can be only updated till order_status is placed. Once the order progresses beyond this status, updates are no longer permitted.
orderID (required): string
The orderID that was received in response to your place order API's request.
project_name (required): string
The name of the project.
maximum allowed 256 characters
webhook_url (optional): string
optional webhook callback URL, which can be used for receiving the final response when the job is completed or error details when it fails.
image_list (required): array
An array of objects each containing image URLs and editing options.
minimum required 1 image
image_urls (required): array
An array of URLs pointing to the images of different exposures to be merged.
minimum required 1 image
client_image_id (optional): string
A unique identifier for each image from the client side. This can be used by the client only for tracking the images. We will not use this for any other purpose.
comment (optional): string
A text field where the user can provide any additional instructions or comments for the editor. This could include specific requests or details to consider during the editing process. maximum allowed 1000 characters
basic_editing (optional): boolean
Flag indicating whether basic editing is applied.
hdr_merge (optional): boolean
Flag indicating whether HDR merging is applied.
sky_replacement (optional): boolean
Flag indicating whether sky replacement is applied.
lawn_replacement (optional): boolean
Flag indicating whether lawn replacement is applied.
tv_screen_replacement (optional): boolean
Flag indicating whether to replace the TV screen in the image with a different display or content.
add_fire_in_fireplace (optional): boolean
Flag indicating whether to digitally add a fire to the fireplace in the image.
remove_snow (optional): boolean
Flag indicating whether to remove snow from the image, making it appear as if the scene is snow-free.
blurring (optional): boolean
Flag indicating whether to apply a blurring effect to specific areas of the image, such as backgrounds or personal details.
object_removal (optional): boolean
Flag indicating whether to remove unwanted objects from the image.
occupied_to_vacant (optional): boolean
Flag indicating whether to digitally remove furniture and other items to make the space appear vacant.
day_to_dusk (optional): boolean
Flag indicating whether to transform a daytime image into a dusk or evening scene.
virtual_staging (optional): boolean
Flag indicating whether to add virtual furniture or décor to an empty or minimally furnished space in the image.
deliver_to_client (optional): boolean
Determines whether the final output should be delivered directly to the client. If set to true, the processed images or order details will be sent to the client's email specified in client_info.
client_info (optional): object
An object containing the client's contact information. This field is required if deliver_to_client is set to true
client_name (optional): string
The name of the client. Optional but recommended for personalized delivery.
maximum allowed 256 characters
client_email (required): string
The email address of the client. This is required for delivering the final output if deliver_to_client is set to true.
payment (optional): object
An object containing the order's payment information.
amount (required): number
The total amount of the payment.
currency (required): string
The currency in which the payment is made. It should follow the ISO 4217 standard. Example: INR (Indian Rupee)
status (optional): string
The current status of the payment.
date (optional): string
The date and time of the payment.
apply_to_all (optional): object
An object specifying default editing options to be applied to all images.
basic_editing (optional): boolean
Flag indicating whether basic editing is applied.
hdr_merge (optional): boolean
Flag indicating whether HDR merging is applied.
sky_replacement (optional): boolean
Flag indicating whether sky replacement is applied.
lawn_replacement (optional): boolean
Flag indicating whether lawn replacement is applied.
tv_screen_replacement (optional): boolean
Flag indicating whether to replace the TV screen in the image with a different display or content.
add_fire_in_fireplace (optional): boolean
Flag indicating whether to digitally add a fire to the fireplace in the image.
remove_snow (optional): boolean
Flag indicating whether to remove snow from the image, making it appear as if the scene is snow-free.
blurring (optional): boolean
Flag indicating whether to apply a blurring effect to specific areas of the image, such as backgrounds or personal details.
object_removal (optional): boolean
Flag indicating whether to remove unwanted objects from the image.
occupied_to_vacant (optional): boolean
Flag indicating whether to digitally remove furniture and other items to make the space appear vacant.
day_to_dusk (optional): boolean
Flag indicating whether to transform a daytime image into a dusk or evening scene.
virtual_staging (optional): boolean
Flag indicating whether to add virtual furniture or décor to an empty or minimally furnished space in the image.
This API provides a presigned URL for each image, allowing secure and temporary access for uploading images directly to cloud storage. The presigned URL is valid for a limited time, ensuring that only authorized uploads occur. Use this URL to upload the image data directly to the specified storage location.
\nfiles_list (required)
An array of objects, each representing a file to be processed.
file_name (required)
The name of the file, including its extension, that is to be uploaded or processed.
This API retrieves a list of all orders, with optional filtering and pagination.
\nUsers can pass various query parameters to refine the results.
\nlimit (optional): Specifies the maximum number of orders to return. The default is 10 if not provided, and the maximum allowed is 100.
\nskip (optional): Specifies the number of orders to skip for paginated results.
\nsort_by (optional): Defines the sorting order of the results. Only the following fields are allowed: createdAt, updatedAt, orderID, payment_date, and their descending counterparts prefixed with - (e.g., -createdAt to sort by creation date in descending order).
\nstart_date (optional): Filters the results to include only the orders created on or after the specified start_date. The date should be in the format YYYY-MM-DD (e.g., 2024-08-22).
\nend_date (optional): Filters the results to include only the orders created up to and including the specified end_date. The end_date is inclusive, meaning records created on the specified end_date will be included in the results.
The date should be in the format YYYY-MM-DD.
order_status (optional): Filters orders by their status. Allowed statuses are: created, processing, post_processing, done, and error.
\norder_type (optional): Filters orders by type, e.g., image_editing.
project_name (optional): Filters orders by project_name. The project_name corresponds to the name of the project provided by the user when placing the order.
\nNote: In one API call, the user can retrieve up to 100 orders. If the limit is not specified in the query, a default of 10 orders will be applied.
This API allows you to delete an existing order. The API identifies the resource to be deleted based on a orderID and deletes the order.
\nNote: Order can be only deleted till order_status is placed. Once the order progresses beyond this status, deletion are no longer permitted.
Use this API to retrieve the details of the order. You will need to provide the orderID that was received in response to your place order API's request.
\nUse this API to retrieve the status and details of the order. You will need to provide the orderID that was received in response to your place order API's request.
\nThe possible values of order_status are placed, pre_processing, post_processing, delivered, and error.
\nplaced: When you initiate a job for processing, the initial status is \"placed.\" This indicates that the job has been successfully queued and is awaiting processing.
\npre_processing: Once your job reaches the front of the queue, our server begins processing it. At this stage, the status will be \"pre_processing.\"
\npost_processing: After the initial processing is complete, we perform some additional steps before marking the job as \"done.\" This phase is denoted as \"post_processing.\"
\nexpert_assigned: This indicates that a human expert has taken over the task. The status will be updated to \"expert_assigned.\"
\ncompleted: Once the entire process is finished and the job has been successfully completed, the status changes to \"completed.\" The output is now available to the user.
\nerror: In the event that a job cannot be processed, it will be marked as \"error.\"
\nThe Health Check API is designed to verify the operational status of the system. It allows you to quickly determine if the API and its underlying services are functioning correctly.
\n","urlObject":{"path":["v2","public","healthCheck"],"host":["https://orderapi.styldod.com"],"query":[],"variable":[]}},"response":[{"id":"7909fd7b-d5f4-4a86-856c-14326432fddd","name":"Health check","originalRequest":{"method":"GET","header":[],"url":"https://orderapi.styldod.com/v2/public/healthCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"74"},{"key":"ETag","value":"W/\"4a-Iyh9MY1j6KbMlrO5pigyturVG2k\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Wed, 28 Aug 2024 09:47:52 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"mesaage\": \"Server is running\",\n \"version\": \"v2\"\n }\n}"}],"_postman_id":"c0d10130-59ed-48e2-a7fb-96dd62caf158"}]}