Add Images Files
Uri: https://api.finerworks.com/v3/add_images
Method: POST

Allows the user to add images to a library.

Body

NameDescriptionTypeAdditional information
images

Image objects data to submit. This assumes the image files will be posted to a url. Insert up to 5 at once.

 array (add_image_details)

Required
library

Contains parameters which indicate the location of the image.

 image_library

Required

Example JSON Body

application/json, text/json

{
  "images": [
    {
      "title": "My Cool Image",
      "description": "This is a really cool picture.",
      "file_name": "abc.jpg",
      "file_size": 11000024,
      "thumbnail_file_name": "thumbnail.jpg",
      "preview_file_name": "preview.jpg",
      "hires_file_name": "hires.jpg",
      "public_thumbnail_uri": "https://somewhere.com/public_thumbnail_uri.jpg",
      "public_preview_uri": "https://somewhere.com/public_preview_uri.jpg",
      "private_hires_uri": "https://somewhere.com/private_hires_uri.jpg",
      "pix_w": 1600,
      "pix_h": 2400
    }
  ],
  "library": {
    "name": "inventory",
    "session_id": "1234567890",
    "account_key": "",
    "site_id": 0
  }
}

Sample Code Library


                        
curl --location --request sample_method 'https://api.finerworks.comsample_endpoint' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "images": [
    {
      "title": "My Cool Image",
      "description": "This is a really cool picture.",
      "file_name": "abc.jpg",
      "file_size": 11000024,
      "thumbnail_file_name": "thumbnail.jpg",
      "preview_file_name": "preview.jpg",
      "hires_file_name": "hires.jpg",
      "public_thumbnail_uri": "https://somewhere.com/public_thumbnail_uri.jpg",
      "public_preview_uri": "https://somewhere.com/public_preview_uri.jpg",
      "private_hires_uri": "https://somewhere.com/private_hires_uri.jpg",
      "pix_w": 1600,
      "pix_h": 2400
    }
  ],
  "library": {
    "name": "inventory",
    "session_id": "1234567890",
    "account_key": "",
    "site_id": 0
  }
}'
                            
                        


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
  'images': [
    {
      'title': 'My Cool Image',
      'description': 'This is a really cool picture.',
      'file_name': 'abc.jpg',
      'file_size': 11000024,
      'thumbnail_file_name': 'thumbnail.jpg',
      'preview_file_name': 'preview.jpg',
      'hires_file_name': 'hires.jpg',
      'public_thumbnail_uri': 'https://somewhere.com/public_thumbnail_uri.jpg',
      'public_preview_uri': 'https://somewhere.com/public_preview_uri.jpg',
      'private_hires_uri': 'https://somewhere.com/private_hires_uri.jpg',
      'pix_w': 1600,
      'pix_h': 2400
    }
  ],
  'library': {
    'name': 'inventory',
    'session_id': '1234567890',
    'account_key': '',
    'site_id': 0
  }
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}

                        


var client = new RestClient("https://api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
  'images': [
    {
      'title': 'My Cool Image',
      'description': 'This is a really cool picture.',
      'file_name': 'abc.jpg',
      'file_size': 11000024,
      'thumbnail_file_name': 'thumbnail.jpg',
      'preview_file_name': 'preview.jpg',
      'hires_file_name': 'hires.jpg',
      'public_thumbnail_uri': 'https://somewhere.com/public_thumbnail_uri.jpg',
      'public_preview_uri': 'https://somewhere.com/public_preview_uri.jpg',
      'private_hires_uri': 'https://somewhere.com/private_hires_uri.jpg',
      'pix_w': 1600,
      'pix_h': 2400
    }
  ],
  'library': {
    'name': 'inventory',
    'session_id': '1234567890',
    'account_key': '',
    'site_id': 0
  }
},  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

                        


var settings = {
"url": "https://api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
  'images': [
    {
      'title': 'My Cool Image',
      'description': 'This is a really cool picture.',
      'file_name': 'abc.jpg',
      'file_size': 11000024,
      'thumbnail_file_name': 'thumbnail.jpg',
      'preview_file_name': 'preview.jpg',
      'hires_file_name': 'hires.jpg',
      'public_thumbnail_uri': 'https://somewhere.com/public_thumbnail_uri.jpg',
      'public_preview_uri': 'https://somewhere.com/public_preview_uri.jpg',
      'private_hires_uri': 'https://somewhere.com/private_hires_uri.jpg',
      'pix_w': 1600,
      'pix_h': 2400
    }
  ],
  'library': {
    'name': 'inventory',
    'session_id': '1234567890',
    'account_key': '',
    'site_id': 0
  }
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

                        

                        
var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};

var req = https.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});

res.on("error", function (error) {
console.error(error);
});
});

var postData = JSON.stringify({
  "images": [
    {
      "title": "My Cool Image",
      "description": "This is a really cool picture.",
      "file_name": "abc.jpg",
      "file_size": 11000024,
      "thumbnail_file_name": "thumbnail.jpg",
      "preview_file_name": "preview.jpg",
      "hires_file_name": "hires.jpg",
      "public_thumbnail_uri": "https://somewhere.com/public_thumbnail_uri.jpg",
      "public_preview_uri": "https://somewhere.com/public_preview_uri.jpg",
      "private_hires_uri": "https://somewhere.com/private_hires_uri.jpg",
      "pix_w": 1600,
      "pix_h": 2400
    }
  ],
  "library": {
    "name": "inventory",
    "session_id": "1234567890",
    "account_key": "",
    "site_id": 0
  }
});

req.write(postData);

req.end();
                            
                        

                        
    require "uri"
    require "net/http"

    url = URI("https://api.finerworks.comsample_endpoint")

    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true

    request = Net::HTTP::sample_method.new(url)
    request["Content-Type"] = "application/json"
    request["web_api_key"] = "my-web-api-key-goes-here"
    request["app_key"] = "my-app-key-goes-here"
    request.body = "{
  'images': [
    {
      'title': 'My Cool Image',
      'description': 'This is a really cool picture.',
      'file_name': 'abc.jpg',
      'file_size': 11000024,
      'thumbnail_file_name': 'thumbnail.jpg',
      'preview_file_name': 'preview.jpg',
      'hires_file_name': 'hires.jpg',
      'public_thumbnail_uri': 'https://somewhere.com/public_thumbnail_uri.jpg',
      'public_preview_uri': 'https://somewhere.com/public_preview_uri.jpg',
      'private_hires_uri': 'https://somewhere.com/private_hires_uri.jpg',
      'pix_w': 1600,
      'pix_h': 2400
    }
  ],
  'library': {
    'name': 'inventory',
    'session_id': '1234567890',
    'account_key': '',
    'site_id': 0
  }
}"

    response = https.request(request)
    puts response.read_body

NameDescriptionTypeAdditional information
status

Response status details

 response_status

None.
images

Returned image value. Returns an id if successful.

 array (image_details)

None.

Example JSON Response

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 201,
    "message": "",
    "debug": null
  },
  "images": [
    {
      "id": 0,
      "guid": "8ebad35a-4f59-4174-b10a-5e9c3611709c",
      "title": "My Image",
      "description": "Some interesting things about this image...",
      "file_name": "myimage.jpg",
      "file_size": 100000,
      "thumbnail_file_name": null,
      "preview_file_name": null,
      "hires_file_name": null,
      "public_thumbnail_uri": "https://finerworks.com/myimages/myimage_thumb.jpg",
      "public_preview_uri": "https://finerworks.com/myimages/myimage_small.jpg",
      "personal_gallery_title": null,
      "members_gallery_category": null,
      "private_hires_uri": "https://finerworks.com/myimages/myimage.jpg",
      "pix_w": 2000,
      "pix_h": 3000,
      "date_added": "2024-11-11T21:46:58.9310335-06:00",
      "date_expires": null,
      "active": true,
      "products": [
        {
          "monetary_format": "USD",
          "quantity": 1,
          "sku": "AP1556P79511",
          "product_code": null,
          "per_item_price": 113.0,
          "total_price": 113.0,
          "asking_price": 200.0,
          "name": null,
          "description_short": null,
          "description_long": null,
          "image_url_1": "https://somewhere.com/image.png",
          "image_url_2": null,
          "image_url_3": null,
          "image_url_4": null,
          "image_url_5": null,
          "image_guid": "8ebad35a-4f59-4174-b10a-5e9c3611709c",
          "product_size": null
        }
      ]
    }
  ]
}