Image file to be processed
Supported formats: JPG, PNG, BMP
| `File` | | **ImageUrl** |URL of the image to be processed
Supported formats: JPG, PNG, BMP
| `ImageUrl` | | **Unit** | Unit of measurement for dimensions | `cm` (centimeters), `in` (inches) | | **ImageWidth** | Desired Width excluding frame, in AR |Any positive number.
Decimals are supported, but fractions are not.
| | **ImageHeight** |Desired Height excluding frame, in AR
(Optional)
|Any positive number.
Decimals are supported, but fractions are not.
| | **MatWidth** |Width of the mat
(Optional)
|0: ignored (no mat)
Any positive number.
Decimals are supported, but fractions are not.
| | **SupportType** | Type of support | `Canvas`, `Dibond`, `Photo`, `Plexiglass`, `Poster`, `Transparent` | | **FrameType** | Type of frame | `None`, `Thin_Wood`, `Large_Wood`, `Thin_Floater`, `Floater`, `Aluminum` | | **FrameColor** | Color of the frame (Optional) | `Black`, `White`, `Natural_Oak`, `Gold`, `Silver`, `Copper` | **Available associations (frame type & color)** * **Thin\_Wood**: available with `Black`, `White`, `Natural_Oak` * **Large\_Wood**: available with `Gold` * **Thin\_Floater**: available with `Black`, `White`, `Natural_Oak` * **Floater**: available with `Black`, `White`, `Natural_Oak` * **Aluminum**: available with `Black`, `White`, `Gold`, `Silver`, `Copper` ### **REQUEST EXAMPLE** | **REQUEST** | **RESPONSE** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | |POST
Content-Type: multipart/form-data
Authorization: Basic api: your-API-key
File: \[image file]
Unit: in
ImageWidth: 24.5
MatWidth: 2
SupportType: Photo
FrameType: Thin\_Wood
FrameColor: Natural\_Oak
{
"PublicLink": "
"QrCodeImage": "
}
| **Example of Javascript code** ```javascript // Function to make the API request async function uploadImage() { // API endpoint const url = 'https://www.frameit.ar/api/frameit'; // Prepare the form data const formData = new FormData(); // Replace this with the URL of the image you want to use const imageUrl = ''; formData.append('ImageUrl', imageUrl); // Append other parameters to the form data formData.append('Unit', 'in'); formData.append('ImageWidth', '24.5'); formData.append('MatWidth', '2'); formData.append('SupportType', 'Photo'); formData.append('FrameType', 'Thin_Wood'); formData.append('FrameColor', 'Natural_Oak'); // Set up the request headers const headers = new Headers(); headers.append('Authorization', 'Basic ' + btoa('api:your-API-key')); // Make the request try { const response = await fetch(url, { method: 'POST', headers: headers, body: formData }); if (!response.ok) { throw new Error(HTTP error! status: ${response.status}); } // Get the response JSON const data = await response.json(); console.log(data); } catch (error) { console.error('Error:', error); } }// Call the function (e.g., on a button click) uploadImage(); ``` **Example of Python code** ```python import requests from requests.auth import HTTPBasicAuth import base64# API endpoint url = 'https://www.frameit.ar/api/frameit'# Your API key api_key = 'Your-API-Key'def get_frameit_response(): # Image file path file_path = 'images/sample1.jpg' files = {'file': open(file_path, 'rb')} # Data payload data = { 'Unit': 'in', 'ImageWidth': 24.5, 'MatWidth': 2, 'SupportType': 'Photo', 'FrameType': 'Thin_Wood', 'FrameColor': 'Natural_Oak' } # Basic authentication auth = HTTPBasicAuth('api', api_key) # Make the POST request response = requests.post(url, files=files, data=data, auth=auth) # Print the response print(response.json()) return response.json()get_frameit_response() ``` **HTTP Response Codes** * **200 OK**: The request has succeeded and the response contains the requested data. * **400 Bad Request**: The request is malformed or contains incorrect parameters. * **500 Internal Server Error**: An error occurred on the server side. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://senar.gitbook.io/frameit-help/frameit-api-documentation.md?ask=