Updates the configuration of an existing Airbox. This endpoint allows you to modify settings such as title, description, password, and target folder.
\n\n\nNote: Only active Airboxes can be updated. Updating a previously deleted Airbox will succeed (with status code 200 Success, but the Airbox will remain inactive and cannot be restored.
\n
Error code responses:
\nSpecial case: If the Airbox has been deleted, the update request still returns 200 but the Airbox remains inactive.
\nTip: When updating an Airbox, use the full Airbox object returned by the List Airboxes endpoint as a template. Since the Update endpoint is a PUT request, omitting fields may result in unintentional removal of existing configurations or data.
\n","urlObject":{"path":["{{Filerobot-Token}}","{{api-version}}","airbox",":airbox_uuid"],"host":["{{api-server}}"],"query":[],"variable":[{"description":{"content":"The unique identifier of the Airbox to update.
\n","type":"text/plain"},"type":"any","value":"46f03254-dba9-4768-b33e-2831f638bca6","key":"airbox_uuid"}]}},"response":[{"id":"0b1a2693-bb4a-43d6-a292-ff8553cad5bc","name":"Update Airbox","originalRequest":{"method":"PUT","header":[{"key":"accept","value":"*/*"},{"key":"content-type","value":"application/json"},{"key":"origin","value":"https://hub.scaleflex.com"},{"key":"x-filerobot-key","value":"{{Filerobot-Key}}","description":"Deactivates an existing Airbox, preventing any new uploads. The Airbox itself remains in the database as an inactive resource, but it is no longer returned by the List Airboxes endpoint.
\nNotes:
\nMultiple attempts to delete the same Airbox will return 200 OK each time.
\n","urlObject":{"path":["{{Filerobot-Token}}","{{api-version}}","airbox",":airbox_uuid"],"host":["{{api-server}}"],"query":[],"variable":[{"description":{"content":"The unique identifier of the Airbox to delete.
\n","type":"text/plain"},"type":"any","value":"954bbf55-e16a-4491-918f-ec781b93ca03","key":"airbox_uuid"}]}},"response":[{"id":"316fd774-74f9-411f-93b0-9590f6212853","name":"Delete Airbox","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"*/*"},{"key":"cache-control","value":"no-cache"},{"key":"origin","value":"https://hub.scaleflex.com"},{"key":"x-filerobot-key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{api-server}}/{{Filerobot-Token}}/{{api-version}}/airbox/:airbox_uuid","host":["{{api-server}}"],"path":["{{Filerobot-Token}}","{{api-version}}","airbox",":airbox_uuid"],"variable":[{"key":"airbox_uuid","value":"954bbf55-e16a-4491-918f-ec781b93ca03","description":"The unique identifier of the Airbox to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 25 Feb 2026 18:31:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Global-Time","value":"265"},{"key":"X-Elastic-Th","value":"0.267"},{"key":"X-Airstore-TraceID","value":"AsIAH48nw9WcaeO"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Geo","value":"ca053"},{"key":"Server","value":"Scaleflex HTTP Loadbalancer"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"X-Airstore-Secret-Key, X-Airstore-Key, X-Filerobot-Key, X-Auth-Token, X-Token, X-Company-Token, X-Project-Token, X-Locale, X-Lang, X-Version, X-Session-Token, X-CSRF-Token, Cache-Control, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version, X-Filerobot-Template, X-Filerobot-Airbox-Puid, Origin"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, POST, DELETE, OPTIONS, PATCH, QUERY"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"msg\": \"Successfully deleted the airbox with uuid=954bbf55-e16a-4491-918f-ec781b93ca03\",\n \"info\": {\n \"duration\": 0.09927773475646973,\n \"api_version\": 5\n },\n \"api_version\": {\n \"module\": \"elastic_v2\",\n \"version\": \"v2510.30.1\"\n }\n}"}],"_postman_id":"02db4928-1584-49d7-a021-1eca0f89eeb0"}],"id":"04a64b7d-75e4-4e59-915f-cc3f9dba519a","description":"The Airbox API allows you to create and manage Airboxes programmatically in the Scaleflex Digital Asset Management (DAM) platform.
\nAn Airbox is a secure upload endpoint that lets external users upload files directly to a folder in your DAM project without requiring access to the DAM interface.
\nAirboxes can optionally include:
\n- \n
Password protection for the upload page
\n \nUpload limits (file size, number of files, total size)
\n \n
The Airbox API exposes endpoints for the following operations:
\n- \n
Create Airbox – generate a new Airbox
\n \nList Airboxes – retrieve all active Airboxes in a project
\n \nUpdate Airbox – modify Airbox configuration
\n \nDelete Airbox – deactivate an Airbox and disable uploads
\n \n
Authentication
\nAll requests must include an API key with the required permission OBJECTS_AIRBOX_MANAGE
Airbox API operations are project-level.
\nResponse schema notice
\nAPI responses may contain fields that are not documented in this specification. Such fields are considered internal implementation details and must not be used by client integrations.
\nScaleflex reserves the right to add, modify, or remove undocumented response fields at any time without impacting the supported API contract.
\n","_postman_id":"04a64b7d-75e4-4e59-915f-cc3f9dba519a"}],"id":"96e0a1f1-65f5-46cf-92c7-154747601676","description":"Scaleflex DAM API to upload, organise, optimise and deliver media assets rocket fast to any channel, any device, any location.
\n➡️ Link to product documentation
\nTo use these APIs, you can get the Filerobot-Token from the VXP Asset Hub:
\nCreate a Filerobot-API-Key with respective permissions from Settings > Project > Access > API keys:
\n\n\n","_postman_id":"96e0a1f1-65f5-46cf-92c7-154747601676"},{"name":"Scaleflex Visual AI","item":[{"name":"Images","item":[{"name":"Enrichment APIs","item":[{"name":"Auto-tagging","item":[{"name":"Autotag Multipart","id":"b484b5b4-a486-4f8d-a265-2dd089331696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"The Demo environment provided with this collection is for demo purposes only and does not contain actual variable values.
\n
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"qnbrGhELF/beach.jpeg"}]},"url":"{{ask-filerobot-server}}/images/autotag/upload/?method=sfx_gmn&confidence=40&limit=50","urlObject":{"path":["images","autotag","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for autotagging, available: 'sfx_gva', 'sfx_gmn'. Default is 'sfx_gmn'.
\n","type":"text/plain"},"key":"method","value":"sfx_gmn"},{"disabled":true,"description":{"content":"A list of language codes for tag translations, separated by commas.
\n","type":"text/plain"},"key":"languages","value":""},{"description":{"content":"Returns only the tags whose confidence (score) is greater than this value.
\n","type":"text/plain"},"key":"confidence","value":"40"},{"description":{"content":"Limits the number of returned tags to this value.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"f43d272a-e121-46a4-992d-a8ab06a49b8c","name":"Autotag Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"wXqtAYaE5/beach.jpeg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/autotag/upload/?method=sfx_gva&languages=fr,es","host":["{{ask-filerobot-server}}"],"path":["images","autotag","upload",""],"query":[{"key":"method","value":"sfx_gva","description":"Method for autotagging, available: 'sfx_gva', 'sfx_img'. Default is 'sfx_gva'. "},{"key":"languages","value":"fr,es","description":"A list of language codes for tag translations, separated by commas."},{"key":"confidence","value":"40","description":"Returns only the tags whose confidence (score) is greater than this value.","disabled":true},{"key":"limit","value":"50","description":"Limits the number of returned tags to this value.","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 17 Jun 2025 08:28:55 GMT"},{"key":"server","value":"uvicorn"},{"key":"response-origin","value":"scaleflex/VisualAI/3.21.0/ask-dev"},{"key":"content-length","value":"2020"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.21.0\",\n \"method\": \"sfx_gva\",\n \"tags\": [\n {\n \"tag\": \"blue\",\n \"confidence\": 98.95\n },\n {\n \"tag\": \"water\",\n \"confidence\": 98.3\n },\n {\n \"tag\": \"body of water\",\n \"confidence\": 98.03\n },\n {\n \"tag\": \"coast\",\n \"confidence\": 94.92\n },\n {\n \"tag\": \"coastal and oceanic landforms\",\n \"confidence\": 94.67\n },\n {\n \"tag\": \"sea\",\n \"confidence\": 94.62\n },\n {\n \"tag\": \"summer\",\n \"confidence\": 92.91\n },\n {\n \"tag\": \"beach\",\n \"confidence\": 91.04\n },\n {\n \"tag\": \"ocean\",\n \"confidence\": 89.99\n },\n {\n \"tag\": \"tropics\",\n \"confidence\": 89.55\n },\n {\n \"tag\": \"shore\",\n \"confidence\": 86.64\n },\n {\n \"tag\": \"caribbean\",\n \"confidence\": 84.64\n },\n {\n \"tag\": \"island\",\n \"confidence\": 80.96\n },\n {\n \"tag\": \"woody plant\",\n \"confidence\": 80.76\n },\n {\n \"tag\": \"palm trees\",\n \"confidence\": 79.21\n },\n {\n \"tag\": \"bay\",\n \"confidence\": 78.53\n },\n {\n \"tag\": \"lagoon\",\n \"confidence\": 62.71\n },\n {\n \"tag\": \"wind wave\",\n \"confidence\": 62.5\n },\n {\n \"tag\": \"royal palms\",\n \"confidence\": 60.44\n },\n {\n \"tag\": \"vacation\",\n \"confidence\": 59.43\n },\n {\n \"tag\": \"headland\",\n \"confidence\": 58.45\n },\n {\n \"tag\": \"wind\",\n \"confidence\": 57.76\n },\n {\n \"tag\": \"babassu\",\n \"confidence\": 57.37\n },\n {\n \"tag\": \"wave\",\n \"confidence\": 56.5\n },\n {\n \"tag\": \"sound\",\n \"confidence\": 55.98\n },\n {\n \"tag\": \"coconut\",\n \"confidence\": 54.59\n },\n {\n \"tag\": \"cape\",\n \"confidence\": 53.83\n },\n {\n \"tag\": \"holiday\",\n \"confidence\": 52.41\n },\n {\n \"tag\": \"promontory\",\n \"confidence\": 50.18\n }\n ],\n \"count\": 29,\n \"request_uuid\": \"238a0f09-8a08-4ccb-9044-b2935f0ef4f3\",\n \"sha1\": \"dcad89c4f36acf59dff64f77d38c57f0747cb3a6\",\n \"file_downloaded\": \"beach.jpeg\"\n}"}],"_postman_id":"b484b5b4-a486-4f8d-a265-2dd089331696"},{"name":"Autotag URL","id":"a899d40e-60fb-4791-8b87-b65a4b879b71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/autotag/:url?method=sfx_gmn&confidence=40&limit=50","urlObject":{"path":["images","autotag",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for autotagging, available: 'sfx_gva', 'sfx_gmn'. Default is 'sfx_gmn'.
\n","type":"text/plain"},"key":"method","value":"sfx_gmn"},{"disabled":true,"description":{"content":"A list of language codes for tag translations, separated by commas.
\n","type":"text/plain"},"key":"languages","value":""},{"description":{"content":"Returns only the tags whose confidence (score) is greater than this value.
\n","type":"text/plain"},"key":"confidence","value":"40"},{"description":{"content":"Limits the number of returned tags to this value.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Automatic assignment of relevant tags and keywords to the given image.
\n","_postman_id":"f8bd2fc4-8c7d-44da-bba0-b24b38319ef5"},{"name":"Brand (logo) recognition","item":[{"name":"Brand detection Multipart","id":"c494256d-c0ae-4ccf-9925-86c3fea55a68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"EMhP8EmKq/mercedes.webp"}]},"url":"{{ask-filerobot-server}}/images/brand-detection/upload/","urlObject":{"path":["images","brand-detection","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"f0da5dd4-cc07-44f1-b00b-eddbdba346c5","name":"Brand detection Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"EMhP8EmKq/mercedes.webp"}]},"url":"{{ask-filerobot-server}}/images/brand-detection/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 14:32:50 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 13af704549c5ac5d9fb78e3b737019ec.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"jqyx8ZF-oydtnktGjqEmYtfRpWqB1qJA43WO6GZWkBCCun-VniwEVw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"df2b8ee89f4dc7ad186b4f9561636c9ac1f0bd97\",\n \"request_uuid\": \"aa3fa931-4859-4584-8b84-8e0ea0e084fb\",\n \"brand\": {\n \"extracted\": [\n {\n \"dimensions\": {\n \"top\": 298,\n \"bottom\": 355,\n \"left\": 704,\n \"right\": 757\n },\n \"vertices\": [\n {\n \"x\": 704,\n \"y\": 298\n },\n {\n \"x\": 757,\n \"y\": 298\n },\n {\n \"x\": 757,\n \"y\": 355\n },\n {\n \"x\": 704,\n \"y\": 355\n }\n ],\n \"classes\": [\n {\n \"class\": \"mercedes-benz\",\n \"label\": \"Mercedes-Benz\"\n }\n ],\n \"meta\": {\n \"id\": \"12ab3400-29ea-11ee-8e1a-4168dc5f1d85\",\n \"type\": \"logo\",\n \"clarity\": 0.7521405567421247,\n \"ocr_confirmed\": false\n }\n },\n {\n \"dimensions\": {\n \"top\": 262,\n \"bottom\": 272,\n \"left\": 714,\n \"right\": 730\n },\n \"vertices\": [\n {\n \"x\": 714,\n \"y\": 262\n },\n {\n \"x\": 730,\n \"y\": 262\n },\n {\n \"x\": 730,\n \"y\": 272\n },\n {\n \"x\": 714,\n \"y\": 272\n }\n ],\n \"classes\": [\n {\n \"class\": \"mercedes-benz\",\n \"label\": \"Mercedes-Benz\"\n }\n ],\n \"meta\": {\n \"id\": \"12ab3401-29ea-11ee-8e1a-4168dc5f1d85\",\n \"type\": \"logo\",\n \"clarity\": 0.17565073977216694,\n \"ocr_confirmed\": false\n }\n }\n ],\n \"has_logo\": true\n }\n}"}],"_postman_id":"c494256d-c0ae-4ccf-9925-86c3fea55a68"},{"name":"Brand detection URL","id":"b2375c8b-49f7-482f-8957-a52a03e0a456","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/brand-detection/:url","urlObject":{"path":["images","brand-detection",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that detect brands (logos) and their positions in the input image. They return the probability for the image to contain a brand and the brand's location coordinates.
\n","_postman_id":"e92cea63-5e2c-4ee0-b719-8d5d7bdc530f"},{"name":"Dominant color extraction","item":[{"name":"Dominant color Multipart","id":"af4fbdaf-a279-44a0-a810-3780b896cdcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"7SlY9ecMV/face.png"}]},"url":"{{ask-filerobot-server}}/images/dominant-color/upload/?max_dominant_colors=3","urlObject":{"path":["images","dominant-color","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Maximum number of dominant colors to show
\n","type":"text/plain"},"key":"max_dominant_colors","value":"3"}],"variable":[]}},"response":[{"id":"11c90285-7cc2-415b-a3e1-43d4659919f2","name":"Dominant color Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"7SlY9ecMV/face.png"}]},"url":{"raw":"{{ask-filerobot-server}}/images/dominant-color/upload/?max_dominant_colors=3","host":["{{ask-filerobot-server}}"],"path":["images","dominant-color","upload",""],"query":[{"key":"max_dominant_colors","value":"3","description":"Maximum number of dominant colors to show"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"756"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 14:43:12 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f762d56afc88f7f52f51da3b63ad4658.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"yr4QO-0IZVsBX1rsbZYuSh--iv8uGVrT5eQZX5LkmG5rRWJrt-yEnQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"request_uuid\": \"8fa2692c-b60d-40c5-aa16-fe2112dc70aa\",\n \"file_downloaded\": \"face.png\",\n \"dominant_colors\": [\n {\n \"color\": \"pink\",\n \"hex\": \"ee6893\",\n \"pixels\": 194956,\n \"ratio\": 0.13,\n \"all\": 1484032\n },\n {\n \"color\": \"yellow\",\n \"hex\": \"ffda27\",\n \"pixels\": 98320,\n \"ratio\": 0.07,\n \"all\": 1484032\n }\n ],\n \"finished_in\": 5.9,\n \"main_colors\": [\n \"pink\",\n \"yellow\",\n \"grass green\"\n ],\n \"main_colors_ratio\": [\n 0.13,\n 0.07,\n 0.05\n ],\n \"main_colors_pixels\": [\n 194956,\n 98320,\n 68663\n ],\n \"main_colors_hex\": [\n \"ee6893\",\n \"ffda27\",\n \"2fb14b\"\n ]\n}"}],"_postman_id":"af4fbdaf-a279-44a0-a810-3780b896cdcf"},{"name":"Dominant color URL","id":"042b9194-349c-4039-a718-320fe8d842b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/dominant-color/:url?max_dominant_colors=3","urlObject":{"path":["images","dominant-color",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Maximum number of dominant colors to show
\n","type":"text/plain"},"key":"max_dominant_colors","value":"3"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that detect dominant colors and return the most frequent colors in the given image.
\n","_postman_id":"b1898794-1392-45b3-8de3-bbac8c0864f9"},{"name":"Face analysis","item":[{"name":"Face analysis Multipart","id":"208c71bf-79c0-4732-877d-17b1203fa9e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"0c0bft0Nq/face.png"}]},"url":"{{ask-filerobot-server}}/images/face-analysis/upload/","urlObject":{"path":["images","face-analysis","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"7f7c986e-f274-48f6-aea3-d1ad9b9e9d50","name":"Face analysis Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"0c0bft0Nq/face.png"}]},"url":"{{ask-filerobot-server}}/images/face-analysis/upload/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"844"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 15:03:04 GMT"},{"key":"X-Connect-Time","value":"0.092"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dc81af6f14945ade0fd126a735f82ac2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"WKLrVbkV6XyPdXgpzCdnBTkgaSYReVLFr_WpoqMozaSE1NX8UxODQw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"request_uuid\": \"2009bd5c-d7ad-4ff4-a5a2-5782c313457a\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ask.filerobot.com/deliver/fbmjmuoeb/2009bd5c-d7ad-4ff4-a5a2-5782c313457a.png\",\n \"faces\": {\n \"face_0\": {\n \"box\": [\n 630,\n 161,\n 940,\n 573\n ],\n \"emotions\": {\n \"angry\": 0.9,\n \"disgust\": 0.29,\n \"fear\": 0.09,\n \"happy\": 2.27,\n \"sad\": 3.59,\n \"surprise\": 0.09,\n \"neutral\": 92.79\n },\n \"dominant_emotion\": \"neutral\",\n \"races\": {\n \"asian\": 0.03,\n \"indian\": 0.06,\n \"black\": 0,\n \"white\": 84.59,\n \"middle eastern\": 7.62,\n \"latino hispanic\": 7.7\n },\n \"dominant_race\": \"white\",\n \"age\": 26,\n \"gender\": \"Female\"\n }\n },\n \"file_downloaded\": \"face.png\"\n}"}],"_postman_id":"208c71bf-79c0-4732-877d-17b1203fa9e9"},{"name":"Face analysis URL","id":"62ae0bdf-c421-4bed-bd96-48dc259e497c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/face-analysis/:url","urlObject":{"path":["images","face-analysis",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that analyze any detected faces in the input image. The following information is included for each detected face:
\n- \n
- bounding box \n
- facial landmarks \n
- expression classification \n
- ethnicity classification \n
- age estimation \n
- gender classification \n
Creates a new classifier.
\nAccepted data:
\n- \n
\nname- Name of the classifier to be created. Should be unique for the given token. \n
\nentities- A text string defining the entities associated with the classifier (e.g.,paintings). Applicable only whentypeisentityorrigid_body. \n
The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[]}},"response":[{"id":"847dfcb0-813c-417a-850b-1377bb398037","name":"Add classifier","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"demo\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ask-filerobot-server}}/images/matcher/classifier/add?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","classifier","add"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"211"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Mar 2025 12:40:20 GMT"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0f954bea3b233fb0b6e1981b1e8b6bd8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"_mZ-F6N0gD_tM0UOxVlTNyeIulZ_Q2Ykkjd8TZ8YqaLFWeWvUZM2lg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.15.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"5073a04e-c5b4-4a87-b26e-6ffd301e191f\",\n \"operation\": \"add_classifier\",\n \"add_classifier\": {\n \"name\": \"demo\",\n \"id\": 28\n }\n}"}],"_postman_id":"b50aef31-9ed4-428c-8433-e30439738a86"},{"name":"Delete classifier","id":"c66e2109-f240-40f2-a96e-b8b1f19f877e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":"{{ask-filerobot-server}}/images/matcher/classifier/delete/:classifier_id?type=face","description":"Removes existing classifier.
\n","urlObject":{"path":["images","matcher","classifier","delete",":classifier_id"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[{"description":{"content":"ID of the classifier to be deleted. Should exist for the given token.
\n","type":"text/plain"},"type":"any","value":"","key":"classifier_id"}]}},"response":[{"id":"1472d3ee-325e-44c5-bd1c-8820dc8243bb","name":"Delete classifier","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{ask-filerobot-server}}/images/matcher/classifier/delete/:classifier_id?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","classifier","delete",":classifier_id"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}],"variable":[{"key":"classifier_id","value":"","description":"ID of the classifier to be deleted. Should exist for the given token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"156"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 15:11:56 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ead5a4c5fbab9ab09302c9bd4c52b4b4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"1lxHT0TsIg_BgxIOtxw9uo_QTshCt-urVmUxuqOUwwkQ0bzCC5aiFQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"8bd34e5f-5c5d-4e01-ba99-20b8be47c535\",\n \"operation\": \"delete_classifier\"\n}"}],"_postman_id":"c66e2109-f240-40f2-a96e-b8b1f19f877e"},{"name":"Edit entities list (EntityMatcher & RigidBodyMatcher)","id":"cb06b8b6-567c-4c8b-9101-6077c1d513c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\"classifier_id\": 2, \"entities\": \"car\"}","options":{"raw":{"language":"json"}}},"url":"{{ask-filerobot-server}}/images/matcher/classifier/edit?type=entity","description":"You can edit the entity list that you defined for your matcher using this endpoint.
\nNote : applicable only when parametertype is entity or rigid_body
Matcher type. Available values : \"entity\", \"rigid_body\"
\n","type":"text/plain"},"key":"type","value":"entity"}],"variable":[]}},"response":[{"id":"24704a2d-63ee-4533-bdf9-b303fcdee1e5","name":"Edit entities list (EntityMacther & RigidBodyMatcher)","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\"classifier_id\": 2, \"entities\": \"car\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ask-filerobot-server}}/images/matcher/classifier/edit?type=entity","host":["{{ask-filerobot-server}}"],"path":["images","matcher","classifier","edit"],"query":[{"key":"type","value":"entity","description":"Matcher type. Available values : \"entity\", \"rigid_body\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"307"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 12 May 2025 03:22:58 GMT"},{"key":"x-sfx-dest-server","value":"eu-ov-104"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f01dafb3bec9893b47152910d47900a4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD12-P3"},{"key":"X-Amz-Cf-Id","value":"1k8L2NQujVShqy1ONub9lic6UxZmI1HZnpUH5NuTv2-nRdTZs4hDvQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.19.1\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"264927bc-28a9-457a-b370-6aee451e92d6\",\n \"operation\": \"edit_classifier_entities\",\n \"edit_classifier_entities\": {\n \"name\": \"my_entity_classifier_new_test\",\n \"id\": 2,\n \"entities\": \"car\",\n \"detect_references\": true\n }\n}"}],"_postman_id":"cb06b8b6-567c-4c8b-9101-6077c1d513c1"},{"name":"List classifiers","id":"9bb24f5b-9d36-407e-a8d7-cd9843ba38d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":"{{ask-filerobot-server}}/images/matcher/classifier/list?type=face","description":"Lists all available classifiers for the token.
\n","urlObject":{"path":["images","matcher","classifier","list"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[]}},"response":[{"id":"b7012e78-113a-4642-a3ce-9b776a9f0f78","name":"List classifiers","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{ask-filerobot-server}}/images/matcher/classifier/list?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","classifier","list"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"290"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 14:59:23 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5893c71b6cde828b408a700f9c0673b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"vp1cS2DRLr7NWxs49CCUqI-RZNrt5WTQGycJJ4IiIpC3EWS1hpnD5g=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"cfa1e07e-73f9-450b-8b25-0beaad51a706\",\n \"operation\": \"list_classifier\",\n \"list_classifier\": [\n {\n \"name\": \"european_politicians\",\n \"id\": 1\n },\n {\n \"name\": \"demo\",\n \"id\": 4\n }\n ]\n}"}],"_postman_id":"9bb24f5b-9d36-407e-a8d7-cd9843ba38d1"},{"name":"Add label","id":"d7524f45-16a8-4d8e-ad65-2600cf2ded53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"classifier_id\": 4,\r\n \"label_names\": [\"label_name\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ask-filerobot-server}}/images/matcher/label/add?type=face","description":"Creates new labels associated with a classifier.
\nAccepted data:
\n- \n
\nclassifier_id- ID of the classifier to which the new labels will be attached. Should exist for the given token. \n
\nlabel_names- A list of names for the labels to be created. Names should be unique for the given classifier ID. \n
The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[]}},"response":[{"id":"3729bbfc-8f2e-4fcd-9aed-ee0fdef8a227","name":"Add label","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"classifier_id\": 4,\r\n \"label_name\": [\"label_name\"]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ask-filerobot-server}}/images/matcher/label/add?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","label","add"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"205"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 14:40:45 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 48b970169016f7185b7cff9e185ee0b2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"aQdqDM8XxIaa61TpKooohGY5CePPTBDdjodi8PhI4OM8cF7L-OZ25A=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"version\":\"3.15.2\",\n \"token\":\"fdocs\",\n \"request_uuid\":\"67d3ba91-a33d-4d83-9f00-11962631102f\",\n \"operation\":\"add_label\",\n \"add_label\":{\n \"labels\":[\n {\n \"name\":\"label_name\",\n \"id\":356\n }\n ],\n \"errors\":[]\n }\n}"}],"_postman_id":"d7524f45-16a8-4d8e-ad65-2600cf2ded53"},{"name":"Delete label","id":"a0dcfa69-c096-43d3-aaf9-70203f1bec2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":"{{ask-filerobot-server}}/images/matcher/label/delete/:label_id?type=face","description":"Removes existing label.
\n","urlObject":{"path":["images","matcher","label","delete",":label_id"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[{"description":{"content":"ID of the label to be deleted. Should exist for the given token.
\n","type":"text/plain"},"type":"any","value":"","key":"label_id"}]}},"response":[{"id":"c3680a3e-ab63-45b3-aba3-af59b908d098","name":"Delete label","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{ask-filerobot-server}}/images/matcher/label/delete/:label_id?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","label","delete",":label_id"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}],"variable":[{"key":"label_id","value":"4","description":" ID of the label to be deleted. Should exist for the given token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 15:11:33 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a2da30f5dacfbd28d77cf4c9702318f8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"OO9C_qGKljB4Dv49O_B-Wai0SL3kAzv7bLAALlf-QZ7-41O9LwTaOA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"f5a4836d-1192-47bd-85ab-3c37e2e7598f\",\n \"operation\": \"delete_label\"\n}"}],"_postman_id":"a0dcfa69-c096-43d3-aaf9-70203f1bec2f"},{"name":"List labels","id":"4ab3d928-8e0a-4cba-a2ed-d265f57bcc10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":"{{ask-filerobot-server}}/images/matcher/label/list/:classifier_id?type=face","description":"Lists all available labels associated with a classifier.
\n","urlObject":{"path":["images","matcher","label","list",":classifier_id"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[{"description":{"content":"ID of the classifier whose labels to list. Should exist for the given token.
\n","type":"text/plain"},"type":"any","value":"","key":"classifier_id"}]}},"response":[{"id":"71e0d248-5c29-4694-a2c8-8e6aed8be882","name":"List labels","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{ask-filerobot-server}}/images/matcher/label/list/:classifier_id?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","label","list",":classifier_id"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}],"variable":[{"key":"classifier_id","value":"","description":"ID of the classifier whose labels to list. Should exist for the given token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"336"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 15:02:40 GMT"},{"key":"X-Connect-Time","value":"0.008"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 77dc0904034d14a129bafe4c9d954f08.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"YSEEI_h52r4F83UHAn6mnAfIDnoHlJIHH6aDbcwW9JbEVvZLYDeC7Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"a8bf6788-0842-4ad4-b697-f99c08341d66\",\n \"operation\": \"list_label\",\n \"list_label\": [\n {\n \"name\": \"emmanuel_macron\",\n \"id\": 1\n },\n {\n \"name\": \"olaf_scholz\",\n \"id\": 2\n },\n {\n \"name\": \"donald_tusk\",\n \"id\": 3\n }\n ]\n}"}],"_postman_id":"4ab3d928-8e0a-4cba-a2ed-d265f57bcc10"},{"name":"Add reference","id":"ed2595c7-c85a-458e-8673-c4b4afd6d660","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"label_id\": 4,\r\n \"uuids\": [\r\n \"f5bd814d-df15-59d4-bbd0-7199f3150000\",\r\n \"47e3dcdf-6d71-57db-b1ca-424803350000\",\r\n \"c972de67-57c6-574c-b304-9e2fb3e50000\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ask-filerobot-server}}/images/matcher/reference/add?type=face","description":"Creates new references associated with a label.
\nAccepted data:
\n- \n
\nlabel_id- ID of the label the new references will be associated with. Should exist for the given token. \n
\nuuids- A list with image UUIDs containing a single object each to be added as references. \n
The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[]}},"response":[{"id":"565520a8-4cf4-484b-8e23-6030a507d890","name":"Add reference","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"label_id\": 4,\r\n \"uuids\": [\r\n \"f5bd814d-df15-59d4-bbd0-7199f3150000\",\r\n \"47e3dcdf-6d71-57db-b1ca-424803350000\",\r\n \"c972de67-57c6-574c-b304-9e2fb3e50000\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ask-filerobot-server}}/images/matcher/reference/add?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","reference","add"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"482"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 14:44:05 GMT"},{"key":"X-Connect-Time","value":"0.080"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 07b0e28d0c589c8a26610bbc5dcd660a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"LDDcYIqDaUCicd65g6QQrYaLRL1BbsBqqDHWjlPsxfI80qgs2V97jQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"008a7823-a0e1-49ce-8dd9-c9a6f86fbe81\",\n \"operation\": \"add_reference\",\n \"add_reference\": {\n \"references\": [\n {\n \"uuid\": \"f5bd814d-df15-59d4-bbd0-7199f3150000\",\n \"id\": 10\n },\n {\n \"uuid\": \"47e3dcdf-6d71-57db-b1ca-424803350000\",\n \"id\": 11\n },\n {\n \"uuid\": \"c972de67-57c6-574c-b304-9e2fb3e50000\",\n \"id\": 12\n }\n ],\n \"errors\": []\n }\n}"}],"_postman_id":"ed2595c7-c85a-458e-8673-c4b4afd6d660"},{"name":"Delete reference","id":"40fc768d-67ff-4f2e-9ed4-5a3a4c41456a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":"{{ask-filerobot-server}}/images/matcher/reference/delete/:reference_id?type=face","description":"Removes existing reference.
\n","urlObject":{"path":["images","matcher","reference","delete",":reference_id"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[{"description":{"content":"ID of the reference to be deleted. Should exist for the given token.
\n","type":"text/plain"},"type":"any","value":"","key":"reference_id"}]}},"response":[{"id":"81c6ff60-778b-45ca-964d-6f7c57ed0bae","name":"Delete reference","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{ask-filerobot-server}}/images/matcher/reference/delete/:reference_id?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","reference","delete",":reference_id"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}],"variable":[{"key":"reference_id","value":"","description":"ID of the reference to be deleted. Should exist for the given token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"155"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 15:10:08 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 924c3fd5fff04ef5cac09fbfc470e618.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"Y_jpF3bfxE8yDKt8N8Ef9-Pm0ZV1UOuqVDDY4_5CJvnm-ad--WilMw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"7274a799-49a9-4749-8631-ae9b0e9a9cd3\",\n \"operation\": \"delete_reference\"\n}"}],"_postman_id":"40fc768d-67ff-4f2e-9ed4-5a3a4c41456a"},{"name":"List references","id":"ad32bbd5-ca55-44d9-8ef5-a9c0e3123ed1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":"{{ask-filerobot-server}}/images/matcher/reference/list/:label_id?type=face","description":"Lists all available references associated with a label.
\n","urlObject":{"path":["images","matcher","reference","list",":label_id"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[{"description":{"content":"ID of the label whose references to list. Should exist for the given token.
\n","type":"text/plain"},"type":"any","value":"","key":"label_id"}]}},"response":[{"id":"e3d04782-aa26-47bc-8afc-e130814843a3","name":"List references","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"url":{"raw":"{{ask-filerobot-server}}/images/matcher/reference/list/:label_id?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","reference","list",":label_id"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}],"variable":[{"key":"label_id","value":"1","description":"ID of the label whose references to list. Should exist for the given token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"415"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 15:04:20 GMT"},{"key":"X-Connect-Time","value":"0.104"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 924c3fd5fff04ef5cac09fbfc470e618.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"yuhHjGRcEELfwG3vYHGKSNxnFzmAJ3JycxObM9_PZw9RM0t561vPFg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.2.2\",\n \"token\": \"fdocs\",\n \"request_uuid\": \"4736c3ba-0b56-48d6-826b-f83edf70791a\",\n \"operation\": \"list_reference\",\n \"list_reference\": [\n {\n \"uuid\": \"f5bd814d-df15-59d4-bbd0-7199f3150000\",\n \"id\": 1\n },\n {\n \"uuid\": \"47e3dcdf-6d71-57db-b1ca-424803350000\",\n \"id\": 2\n },\n {\n \"uuid\": \"c972de67-57c6-574c-b304-9e2fb3e50000\",\n \"id\": 3\n }\n ]\n}"}],"_postman_id":"ad32bbd5-ca55-44d9-8ef5-a9c0e3123ed1"},{"name":"Match label","id":"1a27eb55-ccca-42d0-b8b5-eeb7f138dc40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"classifier_id\": 1,\r\n \"uuid\": \"efad5706-8f2b-58d7-a3a7-52c11ee50000\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ask-filerobot-server}}/images/matcher/match?type=face","description":"Matches input objects to labels associated with a classifier.
\nAccepted data:
\n- \n
\nclassifier_id(optional) - ID of the classifier to use. Should exist for the given token. If not specified, matching is performed for all available classifiers. \n
\nuuid- UUID of an image with the target object. \n
The type of objects that will be matched
\n","type":"text/plain"},"key":"type","value":"face"}],"variable":[]}},"response":[{"id":"372371eb-c45e-478f-a260-377744ca83a3","name":"Match label","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"classifier_id\": 1,\r\n \"uuid\": \"efad5706-8f2b-58d7-a3a7-52c11ee50000\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ask-filerobot-server}}/images/matcher/match?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","match"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"462"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 14:55:59 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 62997e8047323290451b8a864e88914c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"Rnp0qX2bchuN5ceN4FZiTL6Zywqvki9wkhBhDgJJSem3AmHV0C_gcg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"version\":\"3.15.2\",\n \"token\":\"fdocs\",\n \"request_uuid\":\"91adf784-5028-4ff3-aa1f-4e6e7578ca28\",\n \"operation\":\"match_label\",\n \"match_label\":[\n {\n \"classifier_id\":1,\n \"matches\":[\n {\n \"bounding_box\":[\n 294,\n 94,\n 450,\n 291\n ],\n \"name\":\"olaf_scholz\",\n \"label_id\":2,\n \"dist_threshold\":0.3\n },\n {\n \"bounding_box\":[\n 1066,\n 86,\n 1212,\n 290\n ],\n \"name\":\"emmanuel_macron\",\n \"label_id\":1,\n \"dist_threshold\":0.3\n }\n ],\n \"error\":{}\n }\n ]\n}"},{"id":"2cffba1c-16a5-4f22-bd92-c785fc6de3af","name":"Match label (all classifiers)","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"classifier_id\": null,\r\n \"uuid\": \"efad5706-8f2b-58d7-a3a7-52c11ee50000\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ask-filerobot-server}}/images/matcher/match?type=face","host":["{{ask-filerobot-server}}"],"path":["images","matcher","match"],"query":[{"key":"type","value":"face","description":"The type of objects that will be matched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"462"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 10 Jun 2024 14:55:59 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 62997e8047323290451b8a864e88914c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"Rnp0qX2bchuN5ceN4FZiTL6Zywqvki9wkhBhDgJJSem3AmHV0C_gcg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"version\":\"3.15.2\",\n \"token\":\"fdocs\",\n \"request_uuid\":\"39ba7189-c379-4620-9ff6-3253c5ac53fb\",\n \"operation\":\"match_label\",\n \"match_label\":[\n {\n \"classifier_id\":1,\n \"matches\":[\n {\n \"bounding_box\":[\n 294,\n 94,\n 450,\n 291\n ],\n \"name\":\"olaf_scholz\",\n \"label_id\":2,\n \"dist_threshold\":0.3\n },\n {\n \"bounding_box\":[\n 1066,\n 86,\n 1212,\n 290\n ],\n \"name\":\"emmanuel_macron\",\n \"label_id\":1,\n \"dist_threshold\":0.3\n }\n ],\n \"error\":{}\n },\n {\n \"classifier_id\":5,\n \"matches\":[],\n \"error\":{}\n },\n {\n \"classifier_id\":6,\n \"matches\":[],\n \"error\":{}\n },\n {\n \"classifier_id\":7,\n \"matches\":[],\n \"error\":{\n \"hint\":\"Classifier has no associated references\",\n \"error_code\":\"EMPTY_CLASSIFIER\"\n }\n },\n {\n \"classifier_id\":12,\n \"matches\":[],\n \"error\":{\n \"hint\":\"Classifier has no associated references\",\n \"error_code\":\"EMPTY_CLASSIFIER\"\n }\n },\n {\n \"classifier_id\":28,\n \"matches\":[],\n \"error\":{\n \"hint\":\"Classifier has no associated references\",\n \"error_code\":\"EMPTY_CLASSIFIER\"\n }\n }\n ]\n}"}],"_postman_id":"1a27eb55-ccca-42d0-b8b5-eeb7f138dc40"}],"id":"7ba78f86-1316-4fca-9105-b970ab8c8274","description":"A collection of endpoints that offer users the ability to match input UUIDs to previously added references, based on the features of specific objects detected in the images.
\nThe endpoints are generic and can be used with different types of objects. The concrete object type is selected via the query parameter type. The default value if one is not explicitly specified is face - used to match images based on the people in them.
Users can define classifiers, for which they can provide several reference images of the target object (e.g., human faces). When a new image is tested for matches, the defining features of the depicted objects (e.g., faces) are extracted and compared with the previously added references. If a match is detected, the associated label and bounding box of the detected object are returned.
\nThe following query parameters are available for all endpoints:
\n- \n
\ntype- The type of objects that will be matched:- \n
\nface- Matching is performed based on detected human faces. \n
\nentity- Matching is performed based on detected entities (objects specified as a text prompt when creating a classifier, e.g., paintings). \n
\nrigid_body- Matching is performed based on Computer vision feature detection and matching algorithms. \n
\n
local file
\n","type":"file","src":"zNjsC03wK/iqa_00029.jpg"}]},"url":"{{ask-filerobot-server}}/images/image-quality/upload/","urlObject":{"path":["images","image-quality","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"a543b573-daea-4d8f-93d8-f83a77e1d432","name":"Image quality Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"zNjsC03wK/iqa_00029.jpg"}]},"url":"{{ask-filerobot-server}}/images/image-quality/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"204"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 30 Oct 2023 13:52:59 GMT"},{"key":"X-Connect-Time","value":"0.092"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 16f689172b396b7e266a396b6b5d6754.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"FSmNpit89fzhBd0EgoF1Upk2BBBVstLffyVCBxzJAC1qR7W5tuHxpA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.2\",\n \"source\": \"cache-file\",\n \"sha1\": \"4a12c83542e39c85eb412754c9d8a8deefd2822a\",\n \"quality_score\": 0.17,\n \"request_uuid\": \"ffbba05c-6231-4d6e-a8e6-6ae3e1b9cf27\"\n}"}],"_postman_id":"7e4802d4-301b-4858-a523-076033ecb321"},{"name":"Image quality URL","id":"de550b4a-d70a-4d0b-aa1a-3bef8d15ddcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/images/image-quality/:url","urlObject":{"path":["images","image-quality",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that evaluate the technical quality of the input image and return a quality score that reflects a weighted combination of various quality attributes.
\nThe quality score can be used as an estimate to measure the image quality in broader terms, with different values roughly corresponding to the following interpretation :
\n- \n
- Under 0.25: very poor quality; \n
- 0.25 to 0.45: poor to decent quality; \n
- 0.45 to 0.6: decent to good quality; \n
- 0.6 to 0.85: good to very good quality; \n
- Over 0.85: very good to perfect quality; \n
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"AytF8OmwR/plate_number.jpeg"}]},"url":"{{ask-filerobot-server}}/images/plate-number-recognition/upload/","urlObject":{"path":["images","plate-number-recognition","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"6985c7ba-d58f-46ca-af27-cf60141d8cd1","name":"Number plate recognition Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"AytF8OmwR/plate_number.jpeg"}]},"url":"{{ask-filerobot-server}}/images/plate-number-recognition/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"372"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 15:36:56 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e0ed595b39732d9e9972db26854384ec.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"hXF6n3jwM9yjnSqsYl1gxs8f5Jf2RIW7N_QOExllv4uE0ecOWk13-Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"result\": {\n \"source\": \"cache-file\",\n \"sha1\": \"e1d8ac7a4093ad6d4f6db0ff42a690b25b3ff575\",\n \"request_uuid\": \"d971ac4d-7cc6-422d-a4ad-edd27d213633\",\n \"created_on\": \"2023-07-28 12:46:09.529902\",\n \"file_path\": \"/app/app/files/075b962c355aef3a31bb7014/plate_number.jpeg\",\n \"plate_number\": [\n \"LR33 TEE\"\n ]\n }\n}"}],"_postman_id":"6603816c-209c-4587-97b4-8c2179003c7c"},{"name":"Number plate recognition URL","id":"9fa457fe-5af6-4e03-9b72-da92904d978e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/plate-number-recognition/:url","urlObject":{"path":["images","plate-number-recognition",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that recognize any vehicle license plate numbers in the input image.
\n","_postman_id":"7001bb6f-bce7-42bf-9741-61e02e4fbc4e"},{"name":"OCR (text extraction)","item":[{"name":"OCR Multipart","id":"cdff2873-937e-4566-ad77-75d2b64f21f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"laPgfFnTg/text_img.jpeg"}]},"url":"{{ask-filerobot-server}}/images/ocr/upload/?method=sfx_internal","urlObject":{"path":["images","ocr","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for OCR, available: 'sfx_internal', 'sfx_gva' (advanced). Default is 'sfx_internal'.
\n","type":"text/plain"},"key":"method","value":"sfx_internal"}],"variable":[]}},"response":[{"id":"272746d3-c295-40fc-b791-4cf85b4989d9","name":"OCR Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"laPgfFnTg/text_img.jpeg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/ocr/upload/?method=sfx_internal","host":["{{ask-filerobot-server}}"],"path":["images","ocr","upload",""],"query":[{"key":"method","value":"sfx_internal","description":"Method for OCR, available: 'sfx_internal', 'sfx_gva' (advanced). Default is 'sfx_internal'. "}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 17 Feb 2025 10:01:18 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 1717f995f2ca7c5df4d0a972f90c1564.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"VesC9YsRFiAanmypjtTRIaiphVcizqVRF-by6g7m2gAIx-z-cwM0GQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"version\":\"3.13.0\",\n \"result\":{\n \"method\":\"sfx_internal\",\n \"ocr\":\"HOW TO WRITE ALT TEXT AND IMAGE DESCRIPTIONS FOR THE VISUALLY IMPAIRED\",\n \"details\":[\n {\n \"box\":[\n [\n 93,\n 59\n ],\n [\n 431,\n 59\n ],\n [\n 431,\n 104\n ],\n [\n 93,\n 104\n ]\n ],\n \"text\":\"HOW TO WRITE ALT\",\n \"score\":0.97\n },\n {\n \"box\":[\n [\n 115,\n 121\n ],\n [\n 406,\n 121\n ],\n [\n 406,\n 163\n ],\n [\n 115,\n 163\n ]\n ],\n \"text\":\"TEXT AND IMAGE\",\n \"score\":0.96\n },\n {\n \"box\":[\n [\n 100,\n 181\n ],\n [\n 421,\n 181\n ],\n [\n 421,\n 223\n ],\n [\n 100,\n 223\n ]\n ],\n \"text\":\"DESCRIPTIONS FOR\",\n \"score\":0.96\n },\n {\n \"box\":[\n [\n 140,\n 241\n ],\n [\n 381,\n 241\n ],\n [\n 381,\n 283\n ],\n [\n 140,\n 283\n ]\n ],\n \"text\":\"THE VISUALLY\",\n \"score\":0.96\n },\n {\n \"box\":[\n [\n 175,\n 298\n ],\n [\n 344,\n 298\n ],\n [\n 344,\n 345\n ],\n [\n 175,\n 345\n ]\n ],\n \"text\":\"IMPAIRED\",\n \"score\":1.0\n }\n ]\n },\n \"request_uuid\":\"13f60ca7-964b-4434-8a24-38aff13dc93d\",\n \"sha1\":\"6759aa82ca1e93285468f308215721ef616a1de5\",\n \"file_downloaded\":\"text_img.jpeg\"\n}"}],"_postman_id":"cdff2873-937e-4566-ad77-75d2b64f21f3"},{"name":"OCR URL","id":"4e50c8f7-0505-4ea4-ae38-7bbf182982e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/ocr/:url?method=sfx_internal","urlObject":{"path":["images","ocr",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for OCR, available: 'sfx_internal', 'sfx_gva' (advanced). Default is 'sfx_internal'.
\n","type":"text/plain"},"key":"method","value":"sfx_internal"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that utilize optical character recognition techniques to identify and extract text from the input image.
\n","_postman_id":"0f011908-3668-40b1-8613-7b3bd5920856"},{"name":"Product type","item":[{"name":"Product type classification Multipart","id":"233ca8e7-4cb0-4724-9f01-b69702f1d51b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"nG1qmS3qq/product.jpg"}]},"url":"{{ask-filerobot-server}}/images/product-type-classification/upload/","urlObject":{"path":["images","product-type-classification","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"99fb21ca-982b-4874-9193-9264d9de8d43","name":"Product type classification Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"nG1qmS3qq/product.jpg"}]},"url":"{{ask-filerobot-server}}/images/product-type-classification/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"260"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 15:21:15 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3c7ef4fe3f4a27b69b8df486fc6210e4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"wSLa-ytCyATbTj2fCOV6stL6Wj2JupF6DzuZmqdE-cfrhXagkvHGmA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"265e261931bb11559a333395a96ba5c8a33f180a\",\n \"predictions\": [\n {\n \"application\": 0,\n \"product\": 1\n }\n ],\n \"request_uuid\": \"f26d0fc7-9af0-4368-8887-5787064f2f9c\"\n}"}],"_postman_id":"233ca8e7-4cb0-4724-9f01-b69702f1d51b"},{"name":"Product type classification URL","id":"17e65710-daf9-407e-a10a-a61a0d03f693","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/images/product-type-classification/:url","urlObject":{"path":["images","product-type-classification",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Product type classification of the given image. The endpoints return the probability for the input to be either a pure product or an application image, showing the product in use.
\n","_postman_id":"99540b91-b427-4609-bf46-863ba36290dc"},{"name":"Scene classification","item":[{"name":"Scene classification Multipart","id":"d0dec27c-d129-4396-91b4-ff16bc38f0dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"U8gJUqmtG/beach.jpeg"}]},"url":"{{ask-filerobot-server}}/images/scene-classification/upload/","urlObject":{"path":["images","scene-classification","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"0f164020-6969-49b4-919d-32b2b617e4dc","name":"Scene classification Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"U8gJUqmtG/beach.jpeg"}]},"url":"{{ask-filerobot-server}}/images/scene-classification/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"816"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 15:18:57 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5893c71b6cde828b408a700f9c0673b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"EGCe55uYQmYa0lU4sseSfiS_0tn8DVNCSKDRqedV0VUP_08fCuh9Ow=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"dcad89c4f36acf59dff64f77d38c57f0747cb3a6\",\n \"predictions\": {\n \"environment\": \"outdoor\",\n \"scene_categories\": [\n {\n \"category\": \"coast\",\n \"probability\": 0.216\n },\n {\n \"category\": \"lagoon\",\n \"probability\": 0.193\n },\n {\n \"category\": \"ocean\",\n \"probability\": 0.158\n },\n {\n \"category\": \"islet\",\n \"probability\": 0.141\n },\n {\n \"category\": \"cliff\",\n \"probability\": 0.093\n }\n ],\n \"scene_attributes\": [\n \"natural light\",\n \"open area\",\n \"natural\",\n \"boating\",\n \"swimming\",\n \"ocean\",\n \"trees\",\n \"foliage\",\n \"diving\"\n ]\n },\n \"request_uuid\": \"6a1c7781-b529-463e-90a8-4bbb5beb3c28\"\n}"}],"_postman_id":"d0dec27c-d129-4396-91b4-ff16bc38f0dc"},{"name":"Scene classification URL","id":"1d6f89b0-e9e0-4c64-bf8e-f1f1baa10b34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/scene-classification/:url","urlObject":{"path":["images","scene-classification",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Scene classification for the input image. The endpoints return predicted scene categories, scene attributes, and type of environment (indoor/outdoor).
\n","_postman_id":"8aa4637d-e135-4bd8-9f7c-3c3fa1fb2f78"},{"name":"Sports classification","item":[{"name":"Sports classification Multipart","id":"1253ea3b-7017-4793-8bdb-c39096b8b07a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"nTwVurloL/volley.jpg"}]},"url":"{{ask-filerobot-server}}/images/sport-classification/upload/","urlObject":{"path":["images","sport-classification","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"ed08dd7a-4e13-4877-9356-268c60ea89ad","name":"Sports classification Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"nTwVurloL/volley.jpg"}]},"url":"{{ask-filerobot-server}}/images/sport-classification/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"288"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 31 Jul 2023 15:05:22 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1717f995f2ca7c5df4d0a972f90c1564.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"Tov93VRWjfR87JLeX5gsQsZBCjC3QbQm0uNf62FIYrrdhGfnA4rYrg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"0d15b11b279dc80fcbf103c40c88886221553a16\",\n \"sport\": {\n \"info\": {\n \"name\": \"Volleyball\",\n \"confidence\": 0.99\n },\n \"detected\": true\n },\n \"request_uuid\": \"7507ba72-9c5f-4fac-936c-e65fbe9afdf3\"\n}"}],"_postman_id":"1253ea3b-7017-4793-8bdb-c39096b8b07a"},{"name":"Sports classification URL","id":"16d48a04-730c-436b-a776-29c0147a1abe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/sport-classification/:url","urlObject":{"path":["images","sport-classification",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Sports classification for the given image. The endpoints return the depicted sport activity if one was detected.
\n","_postman_id":"de369641-3dc2-4c38-98a5-c724d3afb122"},{"name":"[RE] Property image aesthetic assessment (IAA)","item":[{"name":"Real-estate image aesthetic Multipart","id":"c18befd5-f4f2-4ef3-a8b7-494c9c736e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","value":null}]},"url":"{{ask-filerobot-server}}/images/real-estate-aesthetic/upload/?cache=False&mode=sync&photo_type=bedroom","description":"Quality and aesthetic assessment endpoint for real-estate images.
\nAdd image file in the request body to process.
\nNeed to specify the image type using photo_type parameter, can be null.
Options for photo_type parameter : [living_room, bedroom, dining_room, kitchen_furnished, kitchen_unfurnished, bathroom_furnished, bathroom_unfurnished, unfurnished_room, outdoor, house_exterior, building_exterior, road, field, cave, sign, person, plan, 3d, swimming_pool, corridor, stairs, warehouse_barn_interior, lobby, parking, office_interior, outdoor_dining, toilet, aerial]
Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"},{"description":{"content":"Type of image.
\nOptions : [living_room, bedroom, dining_room, kitchen_furnished, kitchen_unfurnished, bathroom_furnished, bathroom_unfurnished, unfurnished_room, outdoor, house_exterior, building_exterior, road, field, cave, sign, person, plan, 3d, swimming_pool, corridor, stairs, warehouse_barn_interior, lobby, parking, office_interior, outdoor_dining, toilet, aerial]
\n","type":"text/plain"},"key":"photo_type","value":"bedroom"}],"variable":[]}},"response":[{"id":"72c88837-e1c0-4bab-820f-2f5d92842ab2","name":"Real-estate image aesthetic Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","value":null}]},"url":{"raw":"{{ask-filerobot-server}}/images/real-estate-aesthetic/upload/?cache=False&mode=sync&photo_type=bedroom","host":["{{ask-filerobot-server}}"],"path":["images","real-estate-aesthetic","upload",""],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"},{"key":"photo_type","value":"bedroom","description":"Type of image.\n \nOptions : [living_room, bedroom, dining_room, kitchen_furnished, kitchen_unfurnished, bathroom_furnished, bathroom_unfurnished, unfurnished_room, outdoor, house_exterior, building_exterior, road, field, cave, sign, person, plan, 3d, swimming_pool, corridor, stairs, warehouse_barn_interior, lobby, parking, office_interior, outdoor_dining, toilet, aerial]"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"277"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 04 Apr 2024 03:16:10 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 cdb7a265f783ce0c07661e9c6820c2c4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"meWjAfodWIAio1rIhvhIXacxJ_b9psclZsD28BryJM5QbmH6QbkVNw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.10\",\n \"prediction\": {\n \"image_level\": \"medium\",\n \"score\": 0.613,\n \"methods\": [\n \"iqa\",\n \"cos_mean\"\n ]\n },\n \"request_uuid\": \"19ac00c9-3514-4093-a965-2ab8931c2c62\",\n \"sha1\": \"c9108b08cee01e6a4e6b2489b7ad1f68533744bf\"\n}"}],"_postman_id":"c18befd5-f4f2-4ef3-a8b7-494c9c736e59"},{"name":"Real-estate image aesthetic URL","id":"c2db9bc1-fc67-43c2-958f-98c644012812","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{ask-filerobot-server}}/images/real-estate-aesthetic/:url?cache=False&mode=sync&photo_type=bathroom_furnished","description":"Quality and aesthetic assessment endpoint for real-estate images.
\nSpecify the image url you want to process in the path.
\nNeed to specify the image type using photo_type parameter, can be null.
Options for photo_type parameter : [living_room, bedroom, dining_room, kitchen_furnished, kitchen_unfurnished, bathroom_furnished, bathroom_unfurnished, unfurnished_room, outdoor, house_exterior, building_exterior, road, field, cave, sign, person, plan, 3d, swimming_pool, corridor, stairs, warehouse_barn_interior, lobby, parking, office_interior, outdoor_dining, toilet, aerial]
Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"},{"description":{"content":"Type of image.
\nOptions : [living_room, bedroom, dining_room, kitchen_furnished, kitchen_unfurnished, bathroom_furnished, bathroom_unfurnished, unfurnished_room, outdoor, house_exterior, building_exterior, road, field, cave, sign, person, plan, 3d, swimming_pool, corridor, stairs, warehouse_barn_interior, lobby, parking, office_interior, outdoor_dining, toilet, aerial]
\n","type":"text/plain"},"key":"photo_type","value":"bathroom_furnished"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the image to process
\n","type":"text/plain"},"type":"any","value":"https://filerobot.s3.eu-west-3.amazonaws.com/ask/tests/property.6.jpg","key":"url"}]}},"response":[{"id":"f823381a-58ad-4d64-8070-72f7918b7c0f","name":"Real-estate image aesthetic URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://{{ask-filerobot-server}}/images/real-estate-aesthetic/:url?cache=False&mode=sync&photo_type=bathroom_furnished","protocol":"https","host":["{{ask-filerobot-server}}"],"path":["images","real-estate-aesthetic",":url"],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"},{"key":"photo_type","value":"bathroom_furnished","description":"Type of image.\n\nOptions : [living_room, bedroom, dining_room, kitchen_furnished, kitchen_unfurnished, bathroom_furnished, bathroom_unfurnished, unfurnished_room, outdoor, house_exterior, building_exterior, road, field, cave, sign, person, plan, 3d, swimming_pool, corridor, stairs, warehouse_barn_interior, lobby, parking, office_interior, outdoor_dining, toilet, aerial]"}],"variable":[{"key":"url","value":"https://filerobot.s3.eu-west-3.amazonaws.com/ask/tests/property.6.jpg","description":"Url of the image to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"278"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 04 Apr 2024 03:11:35 GMT"},{"key":"X-Connect-Time","value":"0.080"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 6f18ca2e5109f8aa7cd1212932dc4e9a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"kOqwhkzT96iyXl_zjRgRFnAQeNIAuP86csPzDo2263wgJPFLkboI4g=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.10\",\n \"prediction\": {\n \"image_level\": \"medium\",\n \"score\": 0.6573,\n \"methods\": [\n \"iqa\",\n \"cos_mean\"\n ]\n },\n \"request_uuid\": \"e799f227-585c-4789-9186-b03295b90420\",\n \"sha1\": \"4997e2afc3947f88b8483d376defd65258c807fd\"\n}"}],"_postman_id":"c2db9bc1-fc67-43c2-958f-98c644012812"}],"id":"c2226011-20c5-457f-9de5-107d3f2b4d17","description":"Assess quality and aesthetic of real-estate assets.
\n","_postman_id":"c2226011-20c5-457f-9de5-107d3f2b4d17"},{"name":"[RE] Real-estate classification","item":[{"name":"Real-estate classification Multipart","id":"f3229d9c-7ba4-4fc8-b34f-0d03d360d778","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"zhbNMjQUQ/7037b99d-d09a-5810-bcf3-76bba9250000.jpg"}]},"url":"{{ask-filerobot-server}}/images/real-estate-classification/upload/?cache=False&mode=sync","description":"Classifier endpoint for real-estate images.
\nAdd image file in the request body to process.
\n","urlObject":{"path":["images","real-estate-classification","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"}],"variable":[]}},"response":[{"id":"39bc0308-eaa5-42fe-89a1-2943f9343411","name":"Real-estate classification Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"zhbNMjQUQ/7037b99d-d09a-5810-bcf3-76bba9250000.jpg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/real-estate-classification/upload/?cache=False&mode=sync","host":["{{ask-filerobot-server}}"],"path":["images","real-estate-classification","upload",""],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"387"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 Apr 2024 10:31:34 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 d5710f445906ae917df909d01c495c9e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"NEvWWhQwrwndIhi5UoZbIHMMVS2pqlW6brjzVPp8iNljcH_ZECAwLQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.10\",\n \"predictions\": [\n {\n \"description\": \"a photo of a bed room\",\n \"threshold\": 0.65,\n \"is_interior\": true,\n \"is_exterior\": false,\n \"is_furnished\": true,\n \"score\": 0.9991,\n \"result\": \"bedroom\"\n }\n ],\n \"request_uuid\": \"5692df7b-1143-4e76-8dc2-78fbc7087cf9\",\n \"sha1\": \"c9108b08cee01e6a4e6b2489b7ad1f68533744bf\"\n}"}],"_postman_id":"f3229d9c-7ba4-4fc8-b34f-0d03d360d778"},{"name":"Real-estate classification URL","id":"23ec4f8e-04d9-4791-a540-736d0034c34a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"url":"https://{{ask-filerobot-server}}/images/real-estate-classification/:url?cache=False&mode=sync","description":"Classifier endpoint for real-estate images.
\nSpecify the image url you want to process in the path.
\n","urlObject":{"protocol":"https","path":["images","real-estate-classification",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the image to process
\n","type":"text/plain"},"type":"any","value":"https://filerobot.s3.eu-west-3.amazonaws.com/ask/tests/property.6.jpg","key":"url"}]}},"response":[{"id":"8268a591-89f6-4e3f-bb9f-d499c8d4481d","name":"Real-estate classification URL","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"url":{"raw":"https://{{ask-filerobot-server}}/images/real-estate-classification/:url?cache=False&mode=sync","protocol":"https","host":["{{ask-filerobot-server}}"],"path":["images","real-estate-classification",":url"],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"}],"variable":[{"key":"url","value":"https://filerobot.s3.eu-west-3.amazonaws.com/ask/tests/property.6.jpg","description":"Url of the image to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"407"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 Apr 2024 10:30:11 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 48b970169016f7185b7cff9e185ee0b2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"6A3x2AnYUxDPBxTZxzGPOEJHocT3ghHru14dmytDMzLfjaNRH3JcCQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.10\",\n \"predictions\": [\n {\n \"description\": \"a photo of a furnished bathroom\",\n \"threshold\": 0.5,\n \"is_interior\": true,\n \"is_exterior\": false,\n \"is_furnished\": true,\n \"score\": 0.6144,\n \"result\": \"bathroom_furnished\"\n }\n ],\n \"request_uuid\": \"145cc256-8999-4174-92d8-01a394ad3d81\",\n \"sha1\": \"4997e2afc3947f88b8483d376defd65258c807fd\"\n}"}],"_postman_id":"23ec4f8e-04d9-4791-a540-736d0034c34a"}],"id":"e63d3776-33e6-4283-9fa3-161d36a56715","description":"Classification endpoints for real-estate assets.
\n","_postman_id":"e63d3776-33e6-4283-9fa3-161d36a56715"},{"name":"[RE] Real-estate generic","item":[{"name":"Real-estate generic Multipart","id":"e5115c1a-942e-4ab6-ac53-8d5e75df61ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"6_tDvIMiD/7037b99d-d09a-5810-bcf3-76bba9250000.jpg"}]},"url":"{{ask-filerobot-server}}/images/real-estate/upload/?cache=False&mode=sync","description":"Image classifier and aesthetic assessement endpoint for real-estate images.
\nAdd file in the request body to process an single image.
\n","urlObject":{"path":["images","real-estate","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"}],"variable":[]}},"response":[{"id":"20303645-a5b7-4bfa-88e3-a2b18a8fb441","name":"Real-estate generic Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"6_tDvIMiD/7037b99d-d09a-5810-bcf3-76bba9250000.jpg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/real-estate/upload/?cache=False&mode=sync","host":["{{ask-filerobot-server}}"],"path":["images","real-estate","upload",""],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"587"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 Apr 2024 07:21:45 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f762d56afc88f7f52f51da3b63ad4658.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"hhWSR424FV2e4QayEajMWEPdPb0kCEw1jgZGwdMhEio8UQy2PqyR1g=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.10\",\n \"predictions\": [\n {\n \"classification\": {\n \"description\": \"a photo of a bed room\",\n \"threshold\": 0.65,\n \"is_interior\": true,\n \"is_exterior\": false,\n \"is_furnished\": true,\n \"score\": 0.9991,\n \"result\": \"bedroom\"\n },\n \"aesthetic\": {\n \"image_level\": \"medium\",\n \"score\": 0.6129,\n \"methods\": [\n \"iqa\",\n \"cos_mean\"\n ]\n }\n }\n ],\n \"request_uuid\": \"d78893d0-efe9-4f3c-bd1c-6920256bd733\",\n \"sha1\": \"c9108b08cee01e6a4e6b2489b7ad1f68533744bf\"\n}"}],"_postman_id":"e5115c1a-942e-4ab6-ac53-8d5e75df61ab"},{"name":"Real-estate generic URL","id":"713a3e91-ca92-45bf-b063-c4df8b933017","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Token}}","description":"Filerobot API key
\n","type":"text"}],"url":"https://{{ask-filerobot-server}}/images/real-estate/:url?cache=False&mode=sync","description":"Image classifier and aesthetic assessement endpoint for real-estate images.
\nSpecify the image url you want to process in the path.
\n","urlObject":{"protocol":"https","path":["images","real-estate",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
url of the image to process
\n","type":"text/plain"},"type":"any","value":"https://filerobot.s3.eu-west-3.amazonaws.com/ask/tests/property.6.jpg","key":"url"}]}},"response":[{"id":"4c6ea37c-cca9-456d-9d67-52a43439ded2","name":"Real-estate generic URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Token}}","type":"text"}],"url":{"raw":"https://{{ask-filerobot-server}}/images/real-estate/:url?cache=False&mode=sync","protocol":"https","host":["{{ask-filerobot-server}}"],"path":["images","real-estate",":url"],"query":[{"key":"cache","value":"False"},{"key":"mode","value":"sync"}],"variable":[{"key":"url","value":"https://filerobot.s3.eu-west-3.amazonaws.com/ask/tests/property.6.jpg","description":"url of the image to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"606"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 Apr 2024 09:16:40 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 d439433d975e4e608c1677c8e16e7fe2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"OA4qT6GNpYdCyoYVPU8cqFFIXylIbV3q5yFmcIm-Xt3S2eZHcROpqw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.10\",\n \"predictions\": [\n {\n \"classification\": {\n \"description\": \"a photo of a furnished bathroom\",\n \"threshold\": 0.5,\n \"is_interior\": true,\n \"is_exterior\": false,\n \"is_furnished\": true,\n \"score\": 0.6144,\n \"result\": \"bathroom_furnished\"\n },\n \"aesthetic\": {\n \"image_level\": \"medium\",\n \"score\": 0.657,\n \"methods\": [\n \"iqa\",\n \"cos_mean\"\n ]\n }\n }\n ],\n \"request_uuid\": \"57a19d06-0ae7-41e9-8a52-6789b20edc2a\",\n \"sha1\": \"4997e2afc3947f88b8483d376defd65258c807fd\"\n}"}],"_postman_id":"713a3e91-ca92-45bf-b063-c4df8b933017"}],"id":"1e6b593f-6210-44d4-8ac7-39cfc4da9613","description":"Classification and aesthetic assessment for real-estate assets.
\n","_postman_id":"1e6b593f-6210-44d4-8ac7-39cfc4da9613"},{"name":"[Retail] Pack-shot POV","item":[{"name":"Pack-shot POV Multipart","id":"413466ba-8b1d-4ac3-8cab-80c20e3a5e0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","uuid":"bbc85602-f8e9-4e39-ba5b-824fd66de449","src":"68lGnQPRp/tv_4.jpeg"}]},"url":"{{ask-filerobot-server}}/images/packshot-pov/upload/?cache=False&mode=sync","description":"Endpoint to use to send a single local file to process.
\n","urlObject":{"path":["images","packshot-pov","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"}],"variable":[]}},"response":[{"id":"a91672c1-54ab-4536-9413-911481246b05","name":"Pack-shot POV Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"bbc85602-f8e9-4e39-ba5b-824fd66de449","src":"68lGnQPRp/tv_4.jpeg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/packshot-pov/upload/?cache=False&mode=sync","host":["{{ask-filerobot-server}}"],"path":["images","packshot-pov","upload",""],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 25 Feb 2025 10:29:32 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"173"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.14.2\",\n \"pov\": \"front\",\n \"request_uuid\": \"b89a96ed-aadc-40de-819e-061497e8eec1\",\n \"sha1\": \"3f5a1f962c162f21c22165df850440a4705c4e99\"\n}"}],"_postman_id":"413466ba-8b1d-4ac3-8cab-80c20e3a5e0f"},{"name":"Pack-shot POV URL","id":"08c262cb-5041-4051-bbc7-f07d07686e9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"url":"{{ask-filerobot-server}}/images/packshot-pov/:url?cache=False&mode=sync","description":"Endpoint to use to process a image from an url.
\n","urlObject":{"path":["images","packshot-pov",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the image to process
\n","type":"text/plain"},"type":"any","value":"https://try.filerobot.com/erwan/test_pov/G_773562_B.avif?vh=4cd770","key":"url"}]}},"response":[{"id":"305b216e-7451-496a-9d1d-4746db2b1378","name":"Pack-shot POV URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"url":{"raw":"{{ask-filerobot-server}}/images/packshot-pov/:url?cache=False&mode=sync","host":["{{ask-filerobot-server}}"],"path":["images","packshot-pov",":url"],"query":[{"key":"cache","value":"False","description":"Use server cache to accelerate response"},{"key":"mode","value":"sync","description":"Synchronous or asynchronous process"}],"variable":[{"key":"url","value":"https://try.filerobot.com/erwan/test_pov/G_773562_B.avif?vh=4cd770","description":"Url of the image to process"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 25 Feb 2025 10:53:09 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"205"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.14.2\",\n \"source\": \"cache-file\",\n \"sha1\": \"4cd7705c6bc8bbd16beb59de5e74970f5908059f\",\n \"pov\": \"three_fourth\",\n \"request_uuid\": \"65624063-a7be-4b7e-a3b4-e7844b3b5b6c\"\n}"}],"_postman_id":"08c262cb-5041-4051-bbc7-f07d07686e9d"}],"id":"bebacd1e-bace-4d74-a601-6f25d2150ed0","description":"Feature to indentity the angle a pack-shot image has been shot.
\nThe possible labels to describe the image shooting angle are : front, side, top, back, three_fourth, other.
This is the first step to a data pipe-line dedicated to the retail domain and to the GS1 standard.
\n","_postman_id":"bebacd1e-bace-4d74-a601-6f25d2150ed0"},{"name":"[Retail] Nutriscore","item":[{"name":"Nutriscore Detection Multipart","id":"610a2362-c9d2-4f6a-b68b-f3cf6928de72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","uuid":"bbc85602-f8e9-4e39-ba5b-824fd66de449","src":"68lGnQPRp/tv_4.jpeg"}]},"url":"{{ask-filerobot-server}}/images/nutriscore/upload/?cache=False&mode=sync","description":"Endpoint to use to send a single local file to process.
\n","urlObject":{"path":["images","nutriscore","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"}],"variable":[]}},"response":[],"_postman_id":"610a2362-c9d2-4f6a-b68b-f3cf6928de72"},{"name":"Nutriscore Detection URL","id":"2029a07f-fc36-4b46-bdd3-847bc59ee6ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"url":"{{ask-filerobot-server}}/images/nutriscore/:url?cache=False&mode=sync","description":"Endpoint to use to process a image from an url.
\n","urlObject":{"path":["images","nutriscore",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Use server cache to accelerate response
\n","type":"text/plain"},"key":"cache","value":"False"},{"description":{"content":"Synchronous or asynchronous process
\n","type":"text/plain"},"key":"mode","value":"sync"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the image to process
\n","type":"text/plain"},"type":"any","value":"https://try.filerobot.com/erwan/test_pov/G_773562_B.avif?vh=4cd770","key":"url"}]}},"response":[],"_postman_id":"2029a07f-fc36-4b46-bdd3-847bc59ee6ed"}],"id":"557f589a-7b9a-4976-b9e7-f4418a251b86","description":"Endpoint to detect Nutriscore label and extract details.
\n","_postman_id":"557f589a-7b9a-4976-b9e7-f4418a251b86"}],"id":"357a747a-2af8-4378-96a3-6b1139fd0af3","description":"These APIs extract information from images using visual AI to describe, classify and manage large volumes of images more efficiently.
\n","_postman_id":"357a747a-2af8-4378-96a3-6b1139fd0af3"},{"name":"Moderation APIs","item":[{"name":"Face count","item":[{"name":"Face count Multipart","id":"428eb962-17d9-4355-a400-d4b83d494fb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"mtxZzugiw/face.png"}]},"url":"{{ask-filerobot-server}}/images/face-count/upload/?method=sfx_internal","urlObject":{"path":["images","face-count","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Define which model will be used for Face-count, available : 'sfx_internal', 'sfx_gva' (advanced). Default is 'sfx_gva'.
\n","type":"text/plain"},"key":"method","value":"sfx_internal"}],"variable":[]}},"response":[{"id":"fd0f465b-5bea-498a-a4c0-1300c68e27cd","name":"Face count Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"mtxZzugiw/face.png"}]},"url":"{{ask-filerobot-server}}/images/face-count/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"262"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:16:35 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f762d56afc88f7f52f51da3b63ad4658.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"ixqWprXUjEuYxrIQOYPf_aivhl_hQ87upcm_MWjo5eGX1kpi9icgkw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"faces_num\": 1,\n \"message\": \"Only one face found.\",\n \"file_downloaded_in\": 0.85,\n \"request_uuid\": \"149added-101e-49fc-aa84-746bed00ce79\"\n}"}],"_postman_id":"428eb962-17d9-4355-a400-d4b83d494fb8"},{"name":"Face count URL","id":"84a55ad4-0058-4649-93f1-fb439c1bf104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/face-count/:url?method=sfx_internal","urlObject":{"path":["images","face-count",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Define which model will be used for Face-count, available : 'sfx_internal', 'sfx_gva' (advanced). Default is 'sfx_gva'.
\n","type":"text/plain"},"key":"method","value":"sfx_internal"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that detect and return the number of human faces in the input image.
\n","_postman_id":"27686dc5-ad9e-4948-aa90-aee1900e6cc7"},{"name":"Not Safe For Work","item":[{"name":"NSFW Multipart","id":"8a1be745-b09c-4b1e-8384-17448e8b4628","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"b8dqIoR4s/face.png"}]},"url":"{{ask-filerobot-server}}/images/nsfw/upload/","urlObject":{"path":["images","nsfw","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"bd1c7b26-0ccc-4138-9ac1-b837ce61cc44","name":"NSFW Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"xZnwd1sx-/face.png"}]},"url":"{{ask-filerobot-server}}/images/nsfw/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"317"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:18:41 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 924c3fd5fff04ef5cac09fbfc470e618.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"CFindjqtGV2jfrY4RXZOs2lE4z45GOklQ0FKrk1AEc9ItL1bdV0bRQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"predictions\": [\n {\n \"drawing\": 0.02,\n \"hentai\": 0.03,\n \"neutral\": 0.92,\n \"porn\": 0.02,\n \"nsfw\": 0.02\n }\n ],\n \"request_uuid\": \"19fe185e-3221-415c-b885-df90203b0f91\"\n}"}],"_postman_id":"8a1be745-b09c-4b1e-8384-17448e8b4628"},{"name":"NSFW URL","id":"b5a289e8-a692-4d25-8c1e-88fcbd59e599","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/nsfw/:url","urlObject":{"path":["images","nsfw",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that perform adult content (NSFW - Not Safe For Work) detection. They estimate the probability for the given image to be one of the following:
\n- \n
- drawing \n
- hentai \n
- neutral \n
- porn \n
- nsfw \n
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"hUU6PwKOM/auth_img.224.jpg"}]},"url":"{{ask-filerobot-server}}/images/authenticity-detection/upload/","urlObject":{"path":["images","authenticity-detection","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"3824f055-9a0b-42c7-94ab-48b625e1804d","name":"Real estate authenticity Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"hUU6PwKOM/auth_img.224.jpg"}]},"url":"{{ask-filerobot-server}}/images/authenticity-detection/upload/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"256"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 30 Oct 2023 14:41:53 GMT"},{"key":"X-Connect-Time","value":"0.092"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5451b84324d9bca0bdd03e4c4009ae10.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"ZlP_suGWb4-WIqAT-Q6HIBF7_iNaLQuGPneOxcjV8zgwL3mvxpZN7A=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.2\",\n \"source\": \"cache-file\",\n \"sha1\": \"f41ce5c70aa1d46fd4e2152b00d65b8d241a4067\",\n \"predictions\": [\n {\n \"artificial\": 1,\n \"real\": 0\n }\n ],\n \"request_uuid\": \"2179d748-48d6-4466-b5b3-591c72916923\"\n}"}],"_postman_id":"8ad71c69-fbdd-4ed9-8841-5730c8c21e35"},{"name":"Real estate authenticity URL","id":"d57063a8-0938-476c-b43d-9f28148ff668","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/authenticity-detection/:url","urlObject":{"path":["images","authenticity-detection",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that determine the authenticity of real estate images by classifying them into two distinct categories:
\n- \n
- Real images - Authentic images captured via phones and cameras that provide genuine representations of real estate properties. \n
- Artificial images - Images that are synthetically crafted using specialized software and provide visually appealing but artificial and unnatural portrayals of properties. \n
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"GZKYKm96g/animal-africa-wilderness-zoo_wm.jpg"}]},"url":"{{ask-filerobot-server}}/images/watermark-detection/upload/","urlObject":{"path":["images","watermark-detection","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"da7d53e3-cca5-423d-acea-ff3946ef6164","name":"Watermark detection Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"GZKYKm96g/animal-africa-wilderness-zoo_wm.jpg"}]},"url":"{{ask-filerobot-server}}/images/watermark-detection/upload/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"242"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 30 Oct 2023 15:05:53 GMT"},{"key":"X-Connect-Time","value":"0.092"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ead5a4c5fbab9ab09302c9bd4c52b4b4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"_h_M40QACAKjp7wi-GwylKE_34p8jkVsLgrv8ffNm53fMc3DSo8-EA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.0.2\",\n \"predictions\": [\n {\n \"no_watermark\": 0.189,\n \"watermark\": 0.811\n }\n ],\n \"request_uuid\": \"50b932e1-a5db-4801-ac48-44b9d5eb0b8f\",\n \"sha1\": \"e0af32948b6469a8bef58ece415b38ed392595a5\"\n}"}],"_postman_id":"e89cdd0a-b3ee-4ca8-b36b-e8c7e5175722"},{"name":"Watermark detection URL","id":"e17d5732-82eb-439e-ab02-03de9c01affd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/watermark-detection/:url","urlObject":{"path":["images","watermark-detection",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that identify the presence of visual watermarks in the input images.
\n","_postman_id":"83bd6e4a-e6b9-4423-81be-b167488b6536"}],"id":"3325b401-6a03-404e-9ab2-529a27a8176f","description":"These APIs extract information from images with AI and allow to moderate them, for example in User-generated Content (UGC) scenarios.
\n","_postman_id":"3325b401-6a03-404e-9ab2-529a27a8176f"},{"name":"Generative AI","item":[{"name":"Background removal","item":[{"name":"Background removal Multipart","id":"4ca33c8d-9807-43f6-af10-b39e8a0b088b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"_WQlHIsfj/face.png"},{"key":"guidance_file","description":"Generate a new background using this image as guidance. Only available in advanced mode.
\n","type":"file","uuid":"9c3c5934-1eb6-45de-9e3c-5df4ee022fe1","src":"60x9pg57W/beach.jpeg","disabled":true}]},"url":"{{ask-filerobot-server}}/images/remove-background/upload/?method=sfx_basic","urlObject":{"path":["images","remove-background","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for background removal, available : 'sfx_basic', 'sfx_phr' (advanced). Default is'sfx_phr'.
\n","type":"text/plain"},"key":"method","value":"sfx_basic"},{"disabled":true,"description":{"content":"Generate a new background based on this text prompt. Only available in advanced mode.
\n","type":"text/plain"},"key":"background.prompt","value":"a lush forest"},{"disabled":true,"description":{"content":"How closely should the newly generated background match the guiding image (0 to 1). Only available in advanced mode.
\n","type":"text/plain"},"key":"background.guidance.scale","value":"0.6"},{"disabled":true,"description":{"content":"Seed to use during the background generation process. Can be used to achieve consistent results. Only available in advanced mode.
\n","type":"text/plain"},"key":"background.seed","value":"987123"},{"disabled":true,"description":{"content":"Optional parameter used to skip the Remove Background process in case the input image has a percentage of transparent pixels above the defined value. This parameter value has to be an integer between [0-100]. Default value is 0, this means the feature is NOT active.
\n","type":"text/plain"},"key":"skip_if_trans_more_than","value":"10"}],"variable":[]}},"response":[{"id":"b9e9f925-79a6-43e7-b9e1-dcb260229875","name":"Background removal Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"AwJfY0hvG/face.png"}]},"url":{"raw":"{{ask-filerobot-server}}/images/remove-background/upload/?method=sfx_basic","host":["{{ask-filerobot-server}}"],"path":["images","remove-background","upload",""],"query":[{"key":"method","value":"sfx_basic","description":"Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"342"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 07:59:41 GMT"},{"key":"X-Connect-Time","value":"0.000"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e88b34dd0e6a8e6f16f12ba472ae0c12.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"oAl9RRBdODp5mN0L1MvEJpWCXQ8IBdca0QjS_dLOkVwTJjlt6RSFaw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"request_uuid\": \"f913f8d2-2d42-4720-825c-12fc6b52e4cc\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ask.filerobot.com/deliver/fbmjmuoeb/f913f8d2-2d42-4720-825c-12fc6b52e4cc.png\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"method\": \"sfx_basic\",\n \"file_downloaded\": \"face.png\"\n}"},{"id":"4dd86f28-e279-4b96-962d-6ac60f61ab5a","name":"Background generation (prompt) Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"1krPZobqT/face.png"},{"key":"guidance_file","description":"Generate a new background using this image as guidance. Only available in advanced mode.","type":"file","uuid":"9c3c5934-1eb6-45de-9e3c-5df4ee022fe1","src":"60x9pg57W/beach.jpeg","disabled":true}]},"url":{"raw":"{{ask-filerobot-server}}/images/remove-background/upload/?method=sfx_phr&background.prompt=a snowy mountain&background.seed=987123","host":["{{ask-filerobot-server}}"],"path":["images","remove-background","upload",""],"query":[{"key":"method","value":"sfx_phr","description":"Method for background removal, available : 'sfx_basic', 'sfx_phr' (advanced). Default is'sfx_phr'. "},{"key":"background.prompt","value":"a snowy mountain","description":"Generate a new background based on this text prompt. Only available in advanced mode.","type":"text"},{"key":"background.guidance.scale","value":"0.6","description":"How closely should the newly generated background match the guiding image (0 to 1). Only available in advanced mode.","type":"text","disabled":true},{"key":"background.seed","value":"987123","description":"Seed to use during the background generation process. Can be used to achieve consistent results. Only available in advanced mode.","type":"text"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"340"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 11 Apr 2025 08:17:26 GMT"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 929cbb64d024a9973633b197e2a23482.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"s9DWfSEU9Flvq5jqA8jJMRkxdr7-5vwa0kC6iD8G0_uxJX3edyivxQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.18.0\",\n \"file_downloaded\": \"face.png\",\n \"request_uuid\": \"6f9027a9-0f85-44c6-b9de-785015f57b6d\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ai.scaleflex.com/deliver/fbmjmuoeb/6f9027a9-0f85-44c6-b9de-785015f57b6d.png\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"method\": \"sfx_phr\"\n}"},{"id":"fa5cf6a7-d768-4098-81a3-0cccc7974cdc","name":"Background generation (guidance image) Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"1krPZobqT/face.png"},{"key":"guidance_file","description":"Generate a new background using this image as guidance. Only available in advanced mode.","type":"file","uuid":"9c3c5934-1eb6-45de-9e3c-5df4ee022fe1","src":"60x9pg57W/beach.jpeg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/remove-background/upload/?method=sfx_phr&background.guidance.scale=0.9&background.seed=987123","host":["{{ask-filerobot-server}}"],"path":["images","remove-background","upload",""],"query":[{"key":"method","value":"sfx_phr","description":"Method for background removal, available : 'sfx_basic', 'sfx_phr' (advanced). Default is'sfx_phr'. "},{"key":"background.prompt","value":"a snowy mountain","description":"Generate a new background based on this text prompt. Only available in advanced mode.","type":"text","disabled":true},{"key":"background.guidance.scale","value":"0.9","description":"How closely should the newly generated background match the guiding image (0 to 1). Only available in advanced mode.","type":"text"},{"key":"background.seed","value":"987123","description":"Seed to use during the background generation process. Can be used to achieve consistent results. Only available in advanced mode.","type":"text"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"340"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 11 Apr 2025 08:19:18 GMT"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 d439433d975e4e608c1677c8e16e7fe2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"BBAQMt8pEq9Sqy2nXwy1UrrWoLru6h0dXaJvTpLEhEEEc_DI44sJyg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.18.0\",\n \"file_downloaded\": \"face.png\",\n \"request_uuid\": \"1ec075b8-626f-488a-b54b-6c5251ae08b6\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ai.scaleflex.com/deliver/fbmjmuoeb/1ec075b8-626f-488a-b54b-6c5251ae08b6.png\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"method\": \"sfx_phr\"\n}"}],"_postman_id":"4ca33c8d-9807-43f6-af10-b39e8a0b088b"},{"name":"Background removal URL","id":"d0a33ed4-4796-4680-8dd1-10cf95740fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/remove-background/:url?method=sfx_basic","urlObject":{"path":["images","remove-background",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for background removal, available : 'sfx_basic', 'sfx_phr' (advanced). Default is'sfx_phr'.
\n","type":"text/plain"},"key":"method","value":"sfx_basic"},{"disabled":true,"description":{"content":"Generate a new background based on this text prompt. Only available in advanced mode.
\n","type":"text/plain"},"key":"background.prompt","value":"a lush forest"},{"disabled":true,"description":{"content":"Generate a new background using this image as guidance. Only available in advanced mode.
\n","type":"text/plain"},"key":"background.guidance.imageUrl","value":"http://sample.li/andromeda.jpg"},{"disabled":true,"description":{"content":"How closely should the newly generated background match the guiding image (0 to 1). Only available in advanced mode.
\n","type":"text/plain"},"key":"background.guidance.scale","value":"0.6"},{"disabled":true,"description":{"content":"Seed to use during the background generation process. Can be used to achieve consistent results. Only available in advanced mode.
\n","type":"text/plain"},"key":"background.seed","value":"987123"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Optional parameter used to skip the Remove Background process in case the input image has a percentage of transparent pixels above the defined value. This parameter value has to be an integer between [0-100]. Default value is 0, this means the feature is NOT active.
\n","type":"text/plain"},"key":"skip_if_trans_more_than","value":"0"}],"variable":[{"type":"any","value":"http://sample.li/face.png","key":"url"}]}},"response":[{"id":"8de0e93f-f76e-4a7e-b6b8-034fdb4648fc","name":"Background removal URL","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"url":{"raw":"{{ask-filerobot-server}}/images/remove-background/:url?method=sfx_basic","host":["{{ask-filerobot-server}}"],"path":["images","remove-background",":url"],"query":[{"key":"method","value":"sfx_basic","description":"Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)"}],"variable":[{"key":"url","value":"http://sample.li/face.png"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"257"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:00:57 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 07b0e28d0c589c8a26610bbc5dcd660a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"mPeqvZMUN-vhBc1JWyzKYtdvbgBqmrf7yx8DEF3FkVAlS5f3ruIjaQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"result\": \"https://ficttndm.filerobot.com/.internal/remove-background/34e1819b-7ad0-584b-a012-f3aedf950000\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"method\": \"sfx_basic\"\n}"},{"id":"73ba3120-fa83-443d-ad5f-b093d98962e4","name":"Background generation (prompt) URL","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{ask-filerobot-server}}/images/remove-background/:url?method=sfx_phr&background.prompt=an erupting volcano&background.guidance.scale=0.9&background.seed=987123","host":["{{ask-filerobot-server}}"],"path":["images","remove-background",":url"],"query":[{"key":"method","value":"sfx_phr","description":"Method for background removal, available : 'sfx_basic', 'sfx_phr' (advanced). Default is'sfx_phr'. "},{"key":"background.prompt","value":"an erupting volcano","description":"Generate a new background based on this text prompt. Only available in advanced mode.","type":"text"},{"key":"background.guidance.imageUrl","value":"http://sample.li/andromeda.jpg","description":"Generate a new background using this image as guidance. Only available in advanced mode.","type":"text","disabled":true},{"key":"background.guidance.scale","value":"0.9","description":"How closely should the newly generated background match the guiding image (0 to 1). Only available in advanced mode.","type":"text"},{"key":"background.seed","value":"987123","description":"Seed to use during the background generation process. Can be used to achieve consistent results. Only available in advanced mode.","type":"text"}],"variable":[{"key":"url","value":"http://sample.li/face.png"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"374"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 11 Apr 2025 08:25:31 GMT"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 62997e8047323290451b8a864e88914c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"mfXbAHWdHhJGlghv5vGiAxiyNgvSIGfCv7O7ZJAXARcWD4ngJNWBHQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.18.0\",\n \"url\": \"http://sample.li/face.png\",\n \"file_downloaded_in\": 0.29,\n \"request_uuid\": \"930ca635-ae4c-47a9-b857-99f625f40b38\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ai.scaleflex.com/deliver/fbmjmuoeb/930ca635-ae4c-47a9-b857-99f625f40b38.png\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"method\": \"sfx_phr\"\n}"},{"id":"12d767e3-d724-4174-b8c5-04cb718c4f71","name":"Background generation (guidance image) URL","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{ask-filerobot-server}}/images/remove-background/:url?method=sfx_phr&background.guidance.imageUrl=http://sample.li/andromeda.jpg&background.guidance.scale=0.9&background.seed=987123","host":["{{ask-filerobot-server}}"],"path":["images","remove-background",":url"],"query":[{"key":"method","value":"sfx_phr","description":"Method for background removal, available : 'sfx_basic', 'sfx_phr' (advanced). Default is'sfx_phr'. "},{"key":"background.prompt","value":"an erupting volcano","description":"Generate a new background based on this text prompt. Only available in advanced mode.","type":"text","disabled":true},{"key":"background.guidance.imageUrl","value":"http://sample.li/andromeda.jpg","description":"Generate a new background using this image as guidance. Only available in advanced mode.","type":"text"},{"key":"background.guidance.scale","value":"0.9","description":"How closely should the newly generated background match the guiding image (0 to 1). Only available in advanced mode.","type":"text"},{"key":"background.seed","value":"987123","description":"Seed to use during the background generation process. Can be used to achieve consistent results. Only available in advanced mode.","type":"text"}],"variable":[{"key":"url","value":"http://sample.li/face.png"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"374"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 11 Apr 2025 08:26:55 GMT"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f762d56afc88f7f52f51da3b63ad4658.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"WDKiVysEnfn-xYALBuWVp7wPz6LWNc52JzGIgxjIhfE5G_dCipTs7w=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.18.0\",\n \"url\": \"http://sample.li/face.png\",\n \"file_downloaded_in\": 0.24,\n \"request_uuid\": \"5457708e-30f5-4f4b-8341-e7c81e298bcf\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ai.scaleflex.com/deliver/fbmjmuoeb/5457708e-30f5-4f4b-8341-e7c81e298bcf.png\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"method\": \"sfx_phr\"\n}"}],"_postman_id":"d0a33ed4-4796-4680-8dd1-10cf95740fbc"}],"id":"03cf1099-9906-499b-88a8-f22fba33690f","description":"Endpoints that separate foreground subjects from backgrounds and enable generation of transparent assets.
\n","_postman_id":"03cf1099-9906-499b-88a8-f22fba33690f"},{"name":"Object replacement","item":[{"name":"Object replacement Multipart","id":"74b43090-7c44-40d8-90bd-0702caa91a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"Bn80JTlSs/beach.jpeg"},{"key":"mask_file","description":"local mask file
\n- \n
- The mask image should should have the same resolution as the original image. \n
- The mask should be black and white with no grey pixels (i.e., values of only 0 or 255), the value of 0 indicating a pixel to keep as is and 255 - a pixel to inpaint. \n
The textual prompt that guides the image generation.
\n","type":"text/plain"},"key":"prompt","value":"a pirate ship"},{"disabled":true,"description":{"content":"The textual prompt that specifies what not to include during the image generation.
\n","type":"text/plain"},"key":"negative_prompt","value":""},{"disabled":true,"description":{"content":"A higher guidance scale value encourages the model to generate images closely linked to the text prompt at the expense of lower image quality.
\n","type":"text/plain"},"key":"guidance_scale","value":"7.5"},{"disabled":true,"description":{"content":"Specifies the quality to use when generating the image
\n","type":"text/plain"},"key":"quality","value":"standard"},{"disabled":true,"description":{"content":"An integer to make the generation deterministic.
\n","type":"text/plain"},"key":"seed","value":"12"}],"variable":[]}},"response":[{"id":"93c69be7-c0ea-469d-8743-034ec06bba55","name":"Object replacement Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"Bn80JTlSs/beach.jpeg"},{"key":"mask_file","description":"local mask file\n\n- The mask image should should have the same resolution as the original image.\n- The mask should be black and white with no grey pixels (i.e., values of only 0 or 255), the value of 0 indicating a pixel to keep as is and 255 - a pixel to inpaint.","type":"file","uuid":"9c3c5934-1eb6-45de-9e3c-5df4ee022fe1","src":"R3Aw1huhp/beach_mask.png"}]},"url":{"raw":"{{ask-filerobot-server}}/images/replace-object/upload/?prompt=a pirate ship","host":["{{ask-filerobot-server}}"],"path":["images","replace-object","upload",""],"query":[{"key":"prompt","value":"a pirate ship","description":"The textual prompt that guides the image generation."},{"key":"negative_prompt","value":null,"description":"The textual prompt that specifies what not to include during the image generation.","type":"text","disabled":true},{"key":"guidance_scale","value":"7.5","description":"A higher guidance scale value encourages the model to generate images closely linked to the text prompt at the expense of lower image quality.","type":"text","disabled":true},{"key":"quality","value":"standard","description":"Specifies the quality to use when generating the image","type":"text","disabled":true},{"key":"seed","value":null,"description":"An integer to make the generation deterministic.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"435"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Aug 2025 14:33:21 GMT"},{"key":"host","value":"127.0.0.1:81"},{"key":"user-agent","value":"PostmanRuntime/7.45.0"},{"key":"cloudfront-is-mobile-viewer","value":"false"},{"key":"cloudfront-is-tablet-viewer","value":"false"},{"key":"cloudfront-is-smarttv-viewer","value":"false"},{"key":"cloudfront-is-desktop-viewer","value":"true"},{"key":"accept","value":"*/*"},{"key":"cloudfront-forwarded-proto","value":"https"},{"key":"x-forwarded-for","value":"54.86.50.139"},{"key":"via","value":"1.1 ec809871438c11b540493503de981368.cloudfront.net (CloudFront), 1.1 ec809871438c11b540493503de981368.cloudfront.net (CloudFront)"},{"key":"filerobot-token","value":"fbmjmuoeb"},{"key":"filerobot-key","value":"{{vault:authorization-secret---uuid}}"},{"key":"cache-control","value":"no-cache"},{"key":"postman-token","value":"{{vault:authorization-secret---uuid}}"},{"key":"accept-encoding","value":"gzip, deflate, br"},{"key":"cloudfront-viewer-country","value":"US"},{"key":"cloudfront-viewer-asn","value":"14618"},{"key":"x-sfx-origin-server","value":"127.0.0.1"},{"key":"x-sfx-dest-server","value":"eu-ov-103"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"h_Y7Bj_dIdLTLz6pCqMePFNheKsoZ8eZzwyp63w_jDfRoL2C4kJcZQ=="}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.25.1\",\n \"request_uuid\": \"fcfbb31f-416b-4a5c-a990-9b6e737bfd31\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ai.scaleflex.com/deliver/fbmjmuoeb/fcfbb31f-416b-4a5c-a990-9b6e737bfd31.png\",\n \"sha1\": \"dcad89c4f36acf59dff64f77d38c57f0747cb3a6\",\n \"mask_sha1\": \"23a19e107982dc43e77efdd89e09ec8796e56d77\",\n \"file_downloaded\": \"beach.jpeg\",\n \"mask_file\": \"beach_mask.png\"\n}"}],"_postman_id":"74b43090-7c44-40d8-90bd-0702caa91a70"},{"name":"Object replacement URL","id":"05436b0c-4927-48f3-87cc-8640ef7adc2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/replace-object/:url/mask/:mask_url?prompt=a robot","urlObject":{"path":["images","replace-object",":url","mask",":mask_url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"The textual prompt that guides the image generation.
\n","type":"text/plain"},"key":"prompt","value":"a robot"},{"disabled":true,"description":{"content":"The textual prompt that specifies what not to include during the image generation.
\n","type":"text/plain"},"key":"negative_prompt","value":""},{"disabled":true,"description":{"content":"A higher guidance scale value encourages the model to generate images closely linked to the text prompt at the expense of lower image quality.
\n","type":"text/plain"},"key":"guidance_scale","value":"7.5"},{"disabled":true,"description":{"content":"Specifies the quality to use when generating the image
\n","type":"text/plain"},"key":"quality","value":"standard"},{"disabled":true,"description":{"content":"An integer to make the generation deterministic.
\n","type":"text/plain"},"key":"seed","value":"12"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that can replace objects in an image, based on a provided mask file and a text prompt.
\n","_postman_id":"fcf73217-8c7c-482a-a0b8-0fecc2bacd9f"},{"name":"Object removal","item":[{"name":"Object removal Multipart","id":"a4f45b02-65a4-4ef7-a0bb-41c6b1b2def0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"AEtGU1YL6/bench2.png"},{"key":"mask_file","description":"local mask file
\n- \n
- The mask image should should have the same resolution as the original image. \n
- The mask should be black and white with no grey pixels (i.e., values of only 0 or 255), the value of 0 indicating a pixel to keep as is and 255 a pixel to 'clean up'. \n
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/remove-object/:url/mask/:mask_url","urlObject":{"path":["images","remove-object",":url","mask",":mask_url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that can remove objects from an image, based on a provided mask file.
\n","_postman_id":"ac21718e-096b-46b2-981c-149068a9ef72"},{"name":"Image-to-text","item":[{"name":"Image-to-text Multipart","id":"c5bc3cef-be72-450c-bb4c-e98ec1b2fbac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"bwXOgpfmg/touareg.jpg"}]},"url":"{{ask-filerobot-server}}/images/image-to-text/upload/","urlObject":{"path":["images","image-to-text","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"An optional text prompt that guides the generation process . If this parameter is not set, a description of the image is returned. The prompt has to be in English and be less than 30 words.
\n","type":"text/plain"},"key":"prompt","value":""},{"disabled":true,"description":{"content":"Controls the length of the generated response.
\nAvailable values are:
\n- \n
- micro \n
- short \n
- standard \n
- extended \n
An optional string containing comma-separated language codes (e.g., fr,es,it) which will be used to translate the generated output into the specified target languages.
An optional string containing the language code of the default language the generated response will be provided in. English (en) is used by default.
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"url":"{{ask-filerobot-server}}/images/image-to-text/:url?length=standard","urlObject":{"path":["images","image-to-text",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"An optional text prompt that guides the generation process . If this parameter is not set, a description of the image is returned. The prompt has to be in English and be less than 30 words.
\n","type":"text/plain"},"key":"prompt","value":""},{"description":{"content":"Controls the length of the generated response.
\nAvailable values are:
\n- \n
- micro \n
- short \n
- standard \n
- extended \n
An optional string containing comma-separated language codes (e.g., fr,es,it) which will be used to translate the generated output into the specified target languages.
An optional string containing the language code of the default language the generated response will be provided in. English (en) is used by default.
Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that provide general-purpose visual and language understanding by generating textual content based on an input image and an optional textual prompt.
\nThis feature can be useful for compliance with regulations like the European Accessibility Act (EAA) and other EU-wide accessibility standards.
\n","_postman_id":"88f5e9bf-7bce-42d2-aae0-9951fd8d4f5a"},{"name":"Number plate blurring","item":[{"name":"Number plate blurring Multipart","id":"dca43805-2dee-4739-835d-d2e279aeeac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"IG-5vk3X-/plate_number.jpeg"}]},"url":"{{ask-filerobot-server}}/images/plate-blurring/upload/","urlObject":{"path":["images","plate-blurring","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"1a4163f9-ab3e-4e98-8652-e6444aaee572","name":"Number plate blurring Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"IG-5vk3X-/plate_number.jpeg"}]},"url":"{{ask-filerobot-server}}/images/plate-blurring/upload/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"327"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:02:45 GMT"},{"key":"X-Connect-Time","value":"0.080"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 65e185f36e65abff9322e261be3491d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"oxJeQDerFkAwpd6lq1-aMAFCX0CvSs8M9jyamQPuQNw_DNUYABWnnQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"request_uuid\": \"78ff1343-893c-4299-8a29-e5238410112d\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ask.filerobot.com/deliver/fbmjmuoeb/78ff1343-893c-4299-8a29-e5238410112d.png\",\n \"sha1\": \"e1d8ac7a4093ad6d4f6db0ff42a690b25b3ff575\",\n \"file_downloaded\": \"plate_number.jpeg\"\n}"}],"_postman_id":"dca43805-2dee-4739-835d-d2e279aeeac2"},{"name":"Number plate blurring URL","id":"7da33de7-de0b-428a-bac3-1083a9a91a8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/plate-blurring/:url","urlObject":{"path":["images","plate-blurring",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Blurring of license plate numbers in the input image to protect privacy and comply with data regulations.
\n","_postman_id":"65f14332-dfdc-44f0-8b25-9948aeb3d83d"},{"name":"Quality improvement","item":[{"name":"Quality improvement Multipart","id":"60d5d047-2741-415c-80d5-63bb42c6e0e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"LFuctuHLd/beach.jpeg"}]},"url":"{{ask-filerobot-server}}/images/remove-artifacts/upload/?method=sfx_basic&smoothing=50&upscale=2","urlObject":{"path":["images","remove-artifacts","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for artifacts removal (sfx_basic, sfx_cpd)
\n","type":"text/plain"},"key":"method","value":"sfx_basic"},{"description":{"content":"Trade-off between artifacts removal and details preservation
\n","type":"text/plain"},"key":"smoothing","value":"50"},{"description":{"content":"Scaling factor
\n","type":"text/plain"},"key":"upscale","value":"2"}],"variable":[]}},"response":[{"id":"535c65d0-8382-452f-afbf-4fc4250e7c2a","name":"Quality improvement Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"LFuctuHLd/beach.jpeg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/remove-artifacts/upload/?method=sfx_basic&smoothing=100","host":["{{ask-filerobot-server}}"],"path":["images","remove-artifacts","upload",""],"query":[{"key":"method","value":"sfx_basic","description":"Method for artifacts removal (sfx_basic, sfx_cpd)"},{"key":"smoothing","value":"100","description":"Trade-off between artifacts removal and details preservation"},{"key":"upscale","value":"2","description":"Scaling factor","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"339"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:27:47 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dc81af6f14945ade0fd126a735f82ac2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"40HtpWnK5emGQ30FO4_2Ty2OXRnqxp0igNR4WVddbgShLz-GKeBAMQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"request_uuid\": \"cc3bb419-e308-4f46-aa31-2e6347603fb8\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ask.filerobot.com/deliver/fbmjmuoeb/cc3bb419-e308-4f46-aa31-2e6347603fb8.png\",\n \"sha1\": \"dcad89c4f36acf59dff64f77d38c57f0747cb3a6\",\n \"smoothing\": 100,\n \"file_downloaded\": \"beach.jpeg\"\n}"}],"_postman_id":"60d5d047-2741-415c-80d5-63bb42c6e0e8"},{"name":"Quality improvement URL","id":"1665d79a-716c-4129-813f-9e1e07636b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/remove-artifacts/:url?method=sfx_basic&smoothing=100","urlObject":{"path":["images","remove-artifacts",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for artifacts removal (sfx_basic, sfx_cpd)
\n","type":"text/plain"},"key":"method","value":"sfx_basic"},{"description":{"content":"Trade-off between artifacts removal and details preservation
\n","type":"text/plain"},"key":"smoothing","value":"100"},{"disabled":true,"description":{"content":"Scaling factor
\n","type":"text/plain"},"key":"upscale","value":"2"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that detect and remove compression artifacts, enhancing the quality of a given image.
\n","_postman_id":"73cd7f2e-c088-467c-add4-dd86d64bb705"},{"name":"Text-to-image","item":[{"name":"Text-to-image JSON","id":"4569ce84-35b9-42fe-8ea4-e9035fec589b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"a cat eating a slice of watermelon\"\n}"},"url":"{{ask-filerobot-server}}/images/text-to-image?method=standard","urlObject":{"path":["images","text-to-image"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Request type : synchronous or asynchronous. Supported values : \"sync\" / \"async\", default : \"sync\"
\n","type":"text/plain"},"key":"mode ","value":"sync"},{"description":{"content":"Used generative method. Supported values : \"standard\" / \"pro\", default : \"standard\"
\n","type":"text/plain"},"key":"method","value":"standard"},{"disabled":true,"description":{"content":"Output image format, supported formats are : \"jpeg\", \"png\", \"webp\". Default is \"jpeg\".
\n","type":"text/plain"},"key":"image_format","value":"jpeg"},{"disabled":true,"description":{"content":"Output image aspect resolution with format {ratio_width}:{ratio_height}. E.g : \"1:1\", \"16:9\". Default is \"4:3\".
\n","type":"text/plain"},"key":"ratio","value":"4:3"},{"disabled":true,"description":{"content":"Output image resolution, accepted values are : \"512\", \"1K\", \"2K\", \"4K\". Default is \"2K\".
\n","type":"text/plain"},"key":"resolution","value":"2K"}],"variable":[]}},"response":[{"id":"370333f0-279f-4ca5-9fce-9533d90fa54f","name":"Text-to-image JSON","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"a monkey riding a bike\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ask-filerobot-server}}/images/text-to-image"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"286"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:11:57 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ec8b1bfbf511818c606f196b49f871e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"tiv2yH5nKUzp45N0iL5TL3aqGnF8GtjRzVtbgrao9_AN3K-KHOEy1A=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"request_uuid\": \"7cf3c34f-4329-4777-8e54-b56abd4489fe\",\n \"result\": \"https://fbmjmuoeb.filerobot.com/https://ask.filerobot.com/deliver/fbmjmuoeb/7cf3c34f-4329-4777-8e54-b56abd4489fe.png\",\n \"sha1\": \"86fdf95557f7b0a3e07a64ae1aa9e8ed03ab1fbe\"\n}"}],"_postman_id":"4569ce84-35b9-42fe-8ea4-e9035fec589b"}],"id":"64f6e6e1-6cfe-4058-866d-2a0c6a754dae","description":"Generate high-quality and realistic images based on provided text prompts.
\n","_postman_id":"64f6e6e1-6cfe-4058-866d-2a0c6a754dae"},{"name":"Expand background","item":[{"name":"Expand-background Multipart","id":"fec8cffa-c94d-4901-94ae-3eb6319a1238","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"634ihne6p/5.jpg"}]},"url":"{{ask-filerobot-server}}/images/expand-background/upload/?outputRatio=1x1","urlObject":{"path":["images","expand-background","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Resolution of the result image, needs to comply to format \"{width}x{height}\".
\nNotes :
\n- \n
- Parameter cannot be used with outputRatio parameter. \n
- Longest side must be less than 5000 pixels \n
Ratio of the result image, needs to comply to format \"{ratio_width}x{ratio_height}\".
\nNotes :
\n- \n
- Parameter cannot be used with outputSize parameter. \n
- Longest side must be less than 5000 pixels \n
Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/expand-background/:url?outputRatio=1x1","urlObject":{"path":["images","expand-background",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Resolution of the result image, needs to comply to format \"{width}x{height}\".
\nNotes :
\n- \n
- Parameter cannot be used with outputRatio parameter. \n
- Longest side must be less than 5000 pixels \n
Ratio of the result image, needs to comply to format \"{ratio_width}x{ratio_height}\".
\nNotes :
\n- \n
- Parameter cannot be used with outputSize parameter. \n
- Longest side must be less than 5000 pixels \n
Feature to generate a new image with a expanded background.
\nNote : the generated image must have a longest side less than 5000 pixels
\n","_postman_id":"0b8596e1-f68e-4214-b869-859646e01955"},{"name":"Upscaling","item":[{"name":"Upscaling Multipart","id":"a86a10b0-c0d5-4499-b61a-f009abe0bda1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"_ZPqDDsmW/4.jpg"}]},"url":"{{ask-filerobot-server}}/images/image-upscale/upload/","description":"Endpoint to use to send a single local file to process.
\n","urlObject":{"path":["images","image-upscale","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"5aa96f6d-ddb7-4f1e-8aa0-fb7c655298db","name":"Upscaling Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"_ZPqDDsmW/4.jpg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/image-upscale/upload/:url?scale=2","host":["{{ask-filerobot-server}}"],"path":["images","image-upscale","upload",":url"],"query":[{"key":"scale","value":"2","description":"Scaling value, only is available for now."}],"variable":[{"key":"url","value":"https://fdocs.filerobot.com/Todor/squirrel.jpg","description":"Url of the asset to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"307"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 18 Dec 2024 09:38:56 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 06c1d28e93bdae8f6401a12c10b2f570.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD12-P3"},{"key":"X-Amz-Cf-Id","value":"TXrf4SYGeLebi5gBvSQfa2kmVA1U6JnnnauJlmgWTQz-9rf2lyNW3w=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.10.0\",\n \"request_uuid\": \"721224b8-78d2-4e6e-8b9a-9ad80a09e8cd\",\n \"result\": \"https://fdocs.filerobot.com/https://ai.scaleflex.com/deliver/fdocs/721224b8-78d2-4e6e-8b9a-9ad80a09e8cd.png\",\n \"sha1\": \"006c6a4cf889ccdff77549f6486f708d058b500a\",\n \"file_downloaded\": \"4.jpg\"\n}"}],"_postman_id":"a86a10b0-c0d5-4499-b61a-f009abe0bda1"},{"name":"Upscaling URL","id":"00f821b6-493d-4a56-80e8-a7be31048dc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/images/image-upscale/:url","description":"Endpoint to use to process a image from an url.
\n","urlObject":{"path":["images","image-upscale",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the asset to process
\n","type":"text/plain"},"type":"any","value":"https://fdocs.filerobot.com/Todor/squirrel.jpg","key":"url"}]}},"response":[],"_postman_id":"00f821b6-493d-4a56-80e8-a7be31048dc3"}],"id":"1eabf1fd-10e7-4fcc-a66c-8f4c59f32724","description":"Feature to upscale image resolution (x4).
\nThis feature is limited to a maximum of 1000 pixels for the largest side of the image input.
\n","_postman_id":"1eabf1fd-10e7-4fcc-a66c-8f4c59f32724"},{"name":"Image enhancement","item":[{"name":"Enhancement Multipart","id":"3e5ba718-71a1-4fe1-9d17-ff518f94bd47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"gB5h59JMF/upscaled.jpeg"}]},"url":"{{ask-filerobot-server}}/images/image-enhancement/upload/","description":"Endpoint to use to send a single local file to process.
\n","urlObject":{"path":["images","image-enhancement","upload",""],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"892c69ee-1d67-4300-aafe-9a31505643c9","name":"Enhancement Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"DWUMSY0FP/quality_test_2.jpg"}]},"url":"{{ask-filerobot-server}}/images/image-enhancement/upload/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"320"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Jan 2025 04:14:49 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b9e3ae23b2e5d7b2e1c159467ba23f34.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD12-P3"},{"key":"X-Amz-Cf-Id","value":"WeHKNEp0nVqB_fK64L6RNiGbporBQmxjBaRsxL8SUSUw9KIfbxotVQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.12.0\",\n \"request_uuid\": \"c11a9ae7-13d0-4960-ac09-186a1108568b\",\n \"result\": \"https://fdocs.filerobot.com/https://ai.scaleflex.com/deliver/fdocs/c11a9ae7-13d0-4960-ac09-186a1108568b.png\",\n \"sha1\": \"1642ce2cce2a74e0416ee8ca0600e67d2f8fc27b\",\n \"file_downloaded\": \"quality_test_2.jpg\"\n}"}],"_postman_id":"3e5ba718-71a1-4fe1-9d17-ff518f94bd47"},{"name":"Enhancement URL","id":"5dab791f-ecec-4ad7-afd7-c68cd0b16702","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/images/image-enhancement/:url","description":"Endpoint to use to process a image from an url.
\n","urlObject":{"path":["images","image-enhancement",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the image to process
\n","type":"text/plain"},"type":"any","value":"https://try.filerobot.com/erwan/upscaled.jpeg","key":"url"}]}},"response":[{"id":"45da684c-e501-4770-977f-c6ca2789809d","name":"Enhancement Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"DWUMSY0FP/quality_test_2.jpg"}]},"url":"{{ask-filerobot-server}}/images/image-enhancement/upload/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"320"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Jan 2025 04:14:49 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b9e3ae23b2e5d7b2e1c159467ba23f34.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD12-P3"},{"key":"X-Amz-Cf-Id","value":"WeHKNEp0nVqB_fK64L6RNiGbporBQmxjBaRsxL8SUSUw9KIfbxotVQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.12.0\",\n \"request_uuid\": \"c11a9ae7-13d0-4960-ac09-186a1108568b\",\n \"result\": \"https://fdocs.filerobot.com/https://ai.scaleflex.com/deliver/fdocs/c11a9ae7-13d0-4960-ac09-186a1108568b.png\",\n \"sha1\": \"1642ce2cce2a74e0416ee8ca0600e67d2f8fc27b\",\n \"file_downloaded\": \"quality_test_2.jpg\"\n}"}],"_postman_id":"5dab791f-ecec-4ad7-afd7-c68cd0b16702"}],"id":"0140f5f9-4754-45cc-857e-0e882b70d2c6","description":"Feature to enhance image quality : lighting, contrast, color.
\n","_postman_id":"0140f5f9-4754-45cc-857e-0e882b70d2c6"},{"name":"AI relight","item":[{"name":"AI relight Multipart","id":"6372aa14-3a37-4778-831b-6dadbe865321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"t-lfzhhLg/image_enhance_13.jpeg"}]},"url":"{{ask-filerobot-server}}/images/relight/upload/","description":"Endpoint to use to send a single local file to process.
\n","urlObject":{"path":["images","relight","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"4b0708a8-f2cd-46dc-80b9-e0b1576f11a7","name":"AI relight Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"t-lfzhhLg/image_enhance_13.jpeg"}]},"url":{"raw":"{{ask-filerobot-server}}/images/relight/upload/","host":["{{ask-filerobot-server}}"],"path":["images","relight","upload",""],"query":[{"key":"","value":"","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"323"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 08 Apr 2025 05:08:56 GMT"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f01dafb3bec9893b47152910d47900a4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD12-P3"},{"key":"X-Amz-Cf-Id","value":"fNfWePuYu1MFjYWBDvVuyt0YuGYOPpW6PnwnIrhxHTKJk2Nu8IWfsg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.18.0\",\n \"request_uuid\": \"8184b780-0cda-4dc8-b23a-b42275dd924f\",\n \"result\": \"https://fdocs.filerobot.com/https://ai.scaleflex.com/deliver/fdocs/8184b780-0cda-4dc8-b23a-b42275dd924f.png\",\n \"sha1\": \"f554d930a1df400a3da1144a19a6f9d8ee9d72cc\",\n \"file_downloaded\": \"image_enhance_13.jpeg\"\n}"}],"_postman_id":"6372aa14-3a37-4778-831b-6dadbe865321"},{"name":"AI relight URL","id":"ba3fccdf-877e-4554-8333-3adb3cfe57a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/images/relight/:url","description":"Endpoint to use to process a image from an url.
\n","urlObject":{"path":["images","relight",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the asset to process
\n","type":"text/plain"},"type":"any","value":"https://fdocs.filerobot.com/Todor/squirrel.jpg","key":"url"}]}},"response":[],"_postman_id":"ba3fccdf-877e-4554-8333-3adb3cfe57a8"}],"id":"951f97b0-34a3-44ce-b438-7d09882bade1","description":"AI feature that helps to correct under or over exposed photography.
\nPass the original image to endpoint, receive the corrected image.
\nEndpoint to use to send a single local file to process.
\n","urlObject":{"path":["images","edit","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Request type : synchronous or asynchronous. Supported values : \"sync\" / \"async\", default : \"sync\"
\n","type":"text/plain"},"key":"mode","value":"sync"},{"disabled":true,"description":{"content":"Used generative method. Supported values : \"standard\" / \"pro\", default : \"standard\"
\n","type":"text/plain"},"key":"method","value":"standard"},{"disabled":true,"description":{"content":"Output image format in case user wants a different format than the input image, supported formats are : jpeg, png, webp.
\n","type":"text/plain"},"key":"image_format","value":"jpeg"},{"description":{"content":"Text instruction to send to the generative model, this parameter cannot be null or empty.
\n","type":"text/plain"},"key":"prompt","value":"Edit this image for the sky to be blue and the sunny"}],"variable":[]}},"response":[],"_postman_id":"99a845ff-0987-4b03-8196-a831431e7900"},{"name":"Edit Image URL Copy","id":"0a8b21b8-cb50-49f9-ad66-4da13d0804ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/images/edit/:url?prompt=Edit this image to transform the squirrel to a monkey","description":"Endpoint to use to process a image from an url.
\n","urlObject":{"path":["images","edit",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Request type : synchronous or asynchronous. Supported values : \"sync\" / \"async\", default : \"sync\"
\n","type":"text/plain"},"key":"mode","value":"sync"},{"disabled":true,"description":{"content":"Used generative method. Supported values : \"standard\" / \"pro\", default : \"standard\"
\n","type":"text/plain"},"key":"method","value":"standard"},{"disabled":true,"description":{"content":"Output image format in case user wants a different format than the input image, supported formats are : jpeg, png, webp.
\n","type":"text/plain"},"key":"image_format","value":"jpeg"},{"description":{"content":"Text instruction to send to the generative model, this parameter cannot be null or empty.
\n","type":"text/plain"},"key":"prompt","value":"Edit this image to transform the squirrel to a monkey"}],"variable":[{"description":{"content":"Url of the asset to process
\n","type":"text/plain"},"type":"any","value":"https://fdocs.filerobot.com/Todor/squirrel.jpg","key":"url"}]}},"response":[],"_postman_id":"0a8b21b8-cb50-49f9-ad66-4da13d0804ff"}],"id":"23a0f180-19bb-41db-8193-da6f95bbe3a2","description":"Visual AI has a feature to edit images from a prompt.
\nUsing a state of the art Generative model it is possible to modify any image using natural language instructions.
\n","_postman_id":"23a0f180-19bb-41db-8193-da6f95bbe3a2"}],"id":"52cf7d24-7a1d-4078-a393-c44c71997871","description":"These APIs allow to generate various derivatives from an origin image using generative AI models.
\n","_postman_id":"52cf7d24-7a1d-4078-a393-c44c71997871"}],"id":"a0e8c3eb-1b4e-4735-a56d-fdd4bab71524","description":"The following APIs apply to images.
\n","_postman_id":"a0e8c3eb-1b4e-4735-a56d-fdd4bab71524"},{"name":"Video","item":[{"name":"Auto-tagging","item":[{"name":"Autotag Multipart","id":"aa93fa85-35b8-4c06-84e4-7460c0fee90a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","value":null}]},"url":"{{ask-filerobot-server}}/videos/autotag/upload/?method=sfx_gmn&confidence=40&limit=50","urlObject":{"path":["videos","autotag","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for autotagging, available: 'sfx_gva', 'sfx_gmn'. Default is 'sfx_gmn'.
\n","type":"text/plain"},"key":"method","value":"sfx_gmn"},{"disabled":true,"description":{"content":"A list of language codes for tag translations, separated by commas.
\n","type":"text/plain"},"key":"languages","value":""},{"description":{"content":"Returns only the tags whose confidence (score) is greater than this value.
\n","type":"text/plain"},"key":"confidence","value":"40"},{"description":{"content":"Limits the number of returned tags to this value.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"db53f13d-31bd-46bf-ab15-77ce3550e988","name":"Autotag Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"QunssCIJg/test_with_faces.mp4"}]},"url":{"raw":"{{ask-filerobot-server}}/videos/autotag/upload/?method=sfx_gva&limit=10","host":["{{ask-filerobot-server}}"],"path":["videos","autotag","upload",""],"query":[{"key":"method","value":"sfx_gva","description":"Method for autotagging, available: 'sfx_gva'. Default is 'sfx_gva'. "},{"key":"languages","value":"","description":"A list of language codes for tag translations, separated by commas.","disabled":true},{"key":"confidence","value":"40","description":"Returns only the tags whose confidence (score) is greater than this value.","disabled":true},{"key":"limit","value":"10","description":"Limits the number of returned tags to this value."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 17 Jun 2025 08:32:51 GMT"},{"key":"server","value":"uvicorn"},{"key":"response-origin","value":"scaleflex/VisualAI/3.21.0/ask-dev"},{"key":"content-length","value":"897"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.21.0\",\n \"method\": \"sfx_gva\",\n \"tags\": [\n {\n \"tag\": \"stage\",\n \"confidence\": 96.75\n },\n {\n \"tag\": \"television program\",\n \"confidence\": 86.06\n },\n {\n \"tag\": \"performing arts\",\n \"confidence\": 84.07\n },\n {\n \"tag\": \"song\",\n \"confidence\": 83.25\n },\n {\n \"tag\": \"audience\",\n \"confidence\": 82.9\n },\n {\n \"tag\": \"performance\",\n \"confidence\": 76.41\n },\n {\n \"tag\": \"singing\",\n \"confidence\": 65.89\n },\n {\n \"tag\": \"reality television\",\n \"confidence\": 58.42\n },\n {\n \"tag\": \"performance art\",\n \"confidence\": 57.25\n },\n {\n \"tag\": \"concert\",\n \"confidence\": 47.01\n }\n ],\n \"count\": 10,\n \"request_uuid\": \"85a83f4e-0236-4dc5-80ec-98483325f864\",\n \"sha1\": \"424309202a52593e36f0017d27c0e5bb29934eb2\",\n \"file_downloaded\": \"test_with_faces.mp4\"\n}"}],"_postman_id":"aa93fa85-35b8-4c06-84e4-7460c0fee90a"},{"name":"Autotag URL","id":"09d4379a-c6b3-42f9-a4fa-c4a823f0f0d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/videos/autotag/:url?method=sfx_gmn&confidence=40&limit=50","urlObject":{"path":["videos","autotag",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Method for autotagging, available: 'sfx_gva', 'sfx_gmn'. Default is 'sfx_gmn'.
\n","type":"text/plain"},"key":"method","value":"sfx_gmn"},{"disabled":true,"description":{"content":"A list of language codes for tag translations, separated by commas.
\n","type":"text/plain"},"key":"languages","value":""},{"description":{"content":"Returns only the tags whose confidence (score) is greater than this value.
\n","type":"text/plain"},"key":"confidence","value":"40"},{"description":{"content":"Limits the number of returned tags to this value.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Automatic assignment of relevant tags and keywords to the given video.
\n","_postman_id":"885f4d63-a6fc-4ba9-aacf-dae988cba3f9"},{"name":"Face detection","item":[{"name":"Video face detection Multipart","id":"88379d6a-322e-428f-98ed-954b6087c1a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"9NOJLvtX1/test_with_faces.mp4"}]},"url":"{{ask-filerobot-server}}/videos/face-detection/upload/?frame_time=10","urlObject":{"path":["videos","face-detection","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Second to start the search from
\n","type":"text/plain"},"key":"frame_time","value":"10"}],"variable":[]}},"response":[{"id":"59a1ea1a-1cbe-4333-b2c2-4124be3c2a93","name":"Video face detection Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"9NOJLvtX1/test_with_faces.mp4"}]},"url":{"raw":"{{ask-filerobot-server}}/videos/face-detection/upload/?frame_time=0","host":["{{ask-filerobot-server}}"],"path":["videos","face-detection","upload",""],"query":[{"key":"frame_time","value":"0","description":"Second to start the search from"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"322"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Aug 2023 08:33:07 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 90ad2a23a8617490c9d13e1f260633f8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"QoUDLCkPoXjWs7fQ3Wb9y1JJYVcHRwZF21DkUPH75PBfh2ItYPrLdg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"424309202a52593e36f0017d27c0e5bb29934eb2\",\n \"request_uuid\": \"b037e227-5b31-4c99-96ea-14d9bbbc5883\",\n \"video_duration\": 5.08,\n \"video_fps\": 25,\n \"file_downloaded\": \"test_with_faces.mp4\",\n \"faces\": true,\n \"faces_num\": 2,\n \"found_at_time\": 0\n}"}],"_postman_id":"88379d6a-322e-428f-98ed-954b6087c1a9"},{"name":"Video face detection URL","id":"0a6e4a04-eeff-41d8-a942-16061635799e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/videos/face-detection/:url?frame_time=10","urlObject":{"path":["videos","face-detection",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"Second to start the search from
\n","type":"text/plain"},"key":"frame_time","value":"10"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Endpoints that detect the presence of human faces in a given video file.
\n","_postman_id":"aa2054d3-b938-48fb-b748-e2bcfc7dba66"},{"name":"Video-to-text","item":[{"name":"Video-to-text Multipart","id":"14f8a2c2-627b-4061-832f-f76dfc82471c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"q78WztbKN/SampleVideo_1280x720_10mb.mp4"}]},"url":"{{ask-filerobot-server}}/videos/video-to-text/upload/?prompt=How many people are in this video ?&length=standard","description":"Endpoint to send a single local file to process.
\n","urlObject":{"path":["videos","video-to-text","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"A textual prompt that guides the generation process. If you just want video content description ignore this parameter.
\n","type":"text/plain"},"key":"prompt","value":"How many people are in this video ?"},{"description":{"content":"Controls the length of the generated response.
\nAvailable values are: micro, short, standard, extended
\n","type":"text/plain"},"key":"length","value":"standard"}],"variable":[]}},"response":[{"id":"e23f6108-2781-4a71-a464-f80c0a722225","name":"Video-to-text Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"q78WztbKN/SampleVideo_1280x720_10mb.mp4"}]},"url":{"raw":"{{ask-filerobot-server}}/videos/video-to-text/upload/?prompt=How many people are in this video ?&length=standard","host":["{{ask-filerobot-server}}"],"path":["videos","video-to-text","upload",""],"query":[{"key":"prompt","value":"How many people are in this video ?","description":"A textual prompt that guides the generation process. If you just want video content description ignore this parameter."},{"key":"length","value":"standard","description":"Controls the length of the generated response.\n\nAvailable values are:\n micro\n short\n standard\n extended"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"378"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Dec 2024 07:48:32 GMT"},{"key":"X-Connect-Time","value":"0.084"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dc81af6f14945ade0fd126a735f82ac2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"lhSSx-1n6JbUc_-Vk8Xw3iYM1pH64GHd1-YPsp8Fai0_8MaqYLa7Eg=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.10.0\",\n \"video_to_text\": \"There are no people in this video. There is an animated, overweight rabbit and a small glimpse of what appears to be an animated monkey in a tree.\",\n \"request_uuid\": \"652d282e-727b-4ea1-8e3f-6d1a236887cb\",\n \"sha1\": \"799169b0b4184a43da8c3feaa886d92e53f558e8\",\n \"file_downloaded\": \"SampleVideo_1280x720_10mb.mp4\"\n}"}],"_postman_id":"14f8a2c2-627b-4061-832f-f76dfc82471c"},{"name":"Video-to-text URL","id":"f3771022-f194-4cf5-a81f-c50ea3381465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":"{{ask-filerobot-server}}/videos/video-to-text/:url?prompt=How many people are in this video ?&length=standard","description":"Endpoint to process a video from an url.
\n","urlObject":{"path":["videos","video-to-text",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"description":{"content":"A textual prompt that guides the generation process. If you just want video content description ignore this parameter.
\n","type":"text/plain"},"key":"prompt","value":"How many people are in this video ?"},{"description":{"content":"Controls the length of the generated response.\nAvailable values are: micro, short, standard, extended
\n","type":"text/plain"},"key":"length","value":"standard"},{"disabled":true,"description":{"content":"Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the video to process
\n","type":"text/plain"},"type":"any","value":"https://www.quintic.com/software/sample_videos/Golf_Driver_SV.avi","key":"url"}]}},"response":[{"id":"0c367301-a8ad-4af1-9083-9614bd979b4a","name":"Video-to-text URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":{"raw":"{{ask-filerobot-server}}/videos/video-to-text/:url?prompt=How many people are in this video ?&length=standard","host":["{{ask-filerobot-server}}"],"path":["videos","video-to-text",":url"],"query":[{"key":"prompt","value":"How many people are in this video ?","description":"A textual prompt that guides the generation process. If you just want video content description ignore this parameter."},{"key":"length","value":"standard","description":"Controls the length of the generated response.\n\nAvailable values are:\n micro\n short\n standard\n extended"}],"variable":[{"key":"url","value":"https://www.quintic.com/software/sample_videos/Golf_Driver_SV.avi","description":"Url of the video to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"321"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Dec 2024 09:53:24 GMT"},{"key":"X-Connect-Time","value":"0.088"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 90ad2a23a8617490c9d13e1f260633f8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"irpO7EoZtrc0q1V9vIvvuCETt2gBxo0DRhI3yFEx4uJpMUV5tJI0Iw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.10.0\",\n \"video_to_text\": \"There is one person in the video. It's a golfer practicing their swing.\",\n \"request_uuid\": \"b2ad9fc4-96d8-419f-94b2-97264d2f1831\",\n \"sha1\": \"6127959c7897782e28262ef01fc2b47fb93c3250\",\n \"file_downloaded\": \"Golf_Driver_SV.avi\",\n \"file_downloaded_in\": 0.25\n}"}],"_postman_id":"f3771022-f194-4cf5-a81f-c50ea3381465"}],"id":"f5b2a27e-7f72-45ff-b6cc-edcdbbb48382","description":"Endpoints that provide general-purpose visual and language understanding by generating textual content based on an input video and a textual prompt.
\nFor the moment this feature is limited to a maximum of 50 MB video size.
\n","_postman_id":"f5b2a27e-7f72-45ff-b6cc-edcdbbb48382"},{"name":"Video transcription","item":[{"name":"Video transcription Multipart","id":"8ebcc458-ff84-4eb1-a0ea-4f4d843f1283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"1tGRN9Iur/speech.webm"}]},"url":"{{ask-filerobot-server}}/videos/video-transcription/upload/","description":"Endpoint to send a single local file to process.
\n","urlObject":{"path":["videos","video-transcription","upload",""],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Removes text segments from the response if their confidence is lower than this value
\n","type":"text/plain"},"key":"confidence","value":"0.5"},{"disabled":true,"description":{"content":"Includes additional information for each word in the returned text segments
\n","type":"text/plain"},"key":"word_timestamps","value":"true"},{"disabled":true,"description":{"content":"Formats the transcription output as an SRT file (a readable subtitle format that includes both text and timing details). The SRT content is included in the response under the key srt.
Endpoint to process a video from an url.
\n","urlObject":{"path":["videos","video-transcription",":url"],"host":["{{ask-filerobot-server}}"],"query":[{"disabled":true,"description":{"content":"Removes text segments from the response if their confidence is lower than this value
\n","type":"text/plain"},"key":"confidence","value":"0.5"},{"disabled":true,"description":{"content":"Includes additional information for each word in the returned text segments
\n","type":"text/plain"},"key":"word_timestamps","value":"true"},{"disabled":true,"description":{"content":"Formats the transcription output as an SRT file (a readable subtitle format that includes both text and timing details). The SRT content is included in the response under the key srt.
Only relevant if you use the url endpoint. Set to True if you are sending a Base64 encoded URL string.
Url of the video to process
\n","type":"text/plain"},"type":"any","value":"https://try.filerobot.com/trpakov/portals.mp4","key":"url"}]}},"response":[{"id":"c964de74-ac91-48ef-9ede-0224a98c17a9","name":"Video transcription URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":{"raw":"{{ask-filerobot-server}}/videos/video-transcription/:url","host":["{{ask-filerobot-server}}"],"path":["videos","video-transcription",":url"],"query":[{"key":"confidence","value":"0.5","description":"Removes text segments from the response if their confidence is lower than this value","type":"text","disabled":true},{"key":"word_timestamps","value":"True","description":"Includes additional information for each word in the returned text segments","disabled":true}],"variable":[{"key":"url","value":"https://try.filerobot.com/trpakov/portals.mp4","description":"Url of the video to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 04 Apr 2025 10:11:32 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 5893c71b6cde828b408a700f9c0673b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"5FSPNP3-rFGGXg4P_v0tAPNwy9rY7_JX_jCmsbQvRSpagXd9wwsF7Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"version\":\"3.15.2\",\n \"transcription\":{\n \"language\":\"en\",\n \"segments\":[\n {\n \"start\":0.0,\n \"end\":8.0,\n \"text\":\"Welcome to Portals, the ultimate dam extension for fluid brand management.\",\n \"confidence\":0.83\n },\n {\n \"start\":8.0,\n \"end\":15.0,\n \"text\":\"Embrace unified brand identity with our intuitive and customizable templates.\",\n \"confidence\":0.83\n },\n {\n \"start\":15.0,\n \"end\":27.0,\n \"text\":\"Build your portal with ScaleFlex to share media assets like brand guidelines, press releases, and product collections directly from the Asset Hub.\",\n \"confidence\":0.83\n },\n {\n \"start\":27.0,\n \"end\":37.0,\n \"text\":\"And with flexible access management, this feature enhances security in a way users will love.\",\n \"confidence\":0.89\n },\n {\n \"start\":37.0,\n \"end\":40.0,\n \"text\":\"Visit our website to discover more.\",\n \"confidence\":0.89\n }\n ]\n },\n \"request_uuid\":\"a92edbce-0d90-4fe9-8d1f-0a5fea921413\",\n \"sha1\":\"776d1bc8a31b3eae86fceb0b8ea429e12e33e05d\",\n \"file_downloaded\":\"portals.mp4\",\n \"file_downloaded_in\":1.57\n}t"},{"id":"cdeaa664-399d-4114-8ea0-f7d241956998","name":"Video transcription (word timestamps) URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":{"raw":"{{ask-filerobot-server}}/videos/video-transcription/:url?word_timestamps=True","host":["{{ask-filerobot-server}}"],"path":["videos","video-transcription",":url"],"query":[{"key":"confidence","value":"0.5","description":"Removes text segments from the response if their confidence is lower than this value","type":"text","disabled":true},{"key":"word_timestamps","value":"True","description":"Includes additional information for each word in the returned text segments","type":"text"}],"variable":[{"key":"url","value":"https://try.filerobot.com/trpakov/portals.mp4","description":"Url of the video to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 04 Apr 2025 10:11:32 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 5893c71b6cde828b408a700f9c0673b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"5FSPNP3-rFGGXg4P_v0tAPNwy9rY7_JX_jCmsbQvRSpagXd9wwsF7Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"version\":\"3.15.2\",\n \"transcription\":{\n \"language\":\"en\",\n \"segments\":[\n {\n \"start\":2.64,\n \"end\":8.32,\n \"text\":\"Welcome to Portals, the ultimate dam extension for fluid brand management.\",\n \"words\":[\n {\n \"start\":2.64,\n \"end\":3.4,\n \"word\":\"Welcome\",\n \"probability\":0.93\n },\n {\n \"start\":3.4,\n \"end\":3.6,\n \"word\":\"to\",\n \"probability\":1.0\n },\n {\n \"start\":3.6,\n \"end\":4.1,\n \"word\":\"Portals,\",\n \"probability\":0.97\n },\n {\n \"start\":4.24,\n \"end\":5.28,\n \"word\":\"the\",\n \"probability\":0.99\n },\n {\n \"start\":5.28,\n \"end\":5.76,\n \"word\":\"ultimate\",\n \"probability\":0.99\n },\n {\n \"start\":5.76,\n \"end\":6.04,\n \"word\":\"dam\",\n \"probability\":0.55\n },\n {\n \"start\":6.04,\n \"end\":6.56,\n \"word\":\"extension\",\n \"probability\":1.0\n },\n {\n \"start\":6.56,\n \"end\":6.96,\n \"word\":\"for\",\n \"probability\":1.0\n },\n {\n \"start\":6.96,\n \"end\":7.4,\n \"word\":\"fluid\",\n \"probability\":0.9\n },\n {\n \"start\":7.4,\n \"end\":7.68,\n \"word\":\"brand\",\n \"probability\":0.99\n },\n {\n \"start\":7.68,\n \"end\":8.32,\n \"word\":\"management.\",\n \"probability\":1.0\n }\n ],\n \"confidence\":0.83\n },\n {\n \"start\":10.06,\n \"end\":15.04,\n \"text\":\"Embrace unified brand identity with our intuitive and customizable templates.\",\n \"words\":[\n {\n \"start\":10.06,\n \"end\":10.82,\n \"word\":\"Embrace\",\n \"probability\":1.0\n },\n {\n \"start\":10.82,\n \"end\":11.44,\n \"word\":\"unified\",\n \"probability\":0.98\n },\n {\n \"start\":11.44,\n \"end\":11.76,\n \"word\":\"brand\",\n \"probability\":1.0\n },\n {\n \"start\":11.76,\n \"end\":12.3,\n \"word\":\"identity\",\n \"probability\":1.0\n },\n {\n \"start\":12.3,\n \"end\":12.68,\n \"word\":\"with\",\n \"probability\":0.99\n },\n {\n \"start\":12.68,\n \"end\":12.86,\n \"word\":\"our\",\n \"probability\":1.0\n },\n {\n \"start\":12.86,\n \"end\":13.36,\n \"word\":\"intuitive\",\n \"probability\":0.99\n },\n {\n \"start\":13.36,\n \"end\":13.72,\n \"word\":\"and\",\n \"probability\":1.0\n },\n {\n \"start\":13.72,\n \"end\":14.36,\n \"word\":\"customizable\",\n \"probability\":0.98\n },\n {\n \"start\":14.36,\n \"end\":15.04,\n \"word\":\"templates.\",\n \"probability\":1.0\n }\n ],\n \"confidence\":0.83\n },\n {\n \"start\":15.58,\n \"end\":27.6,\n \"text\":\"Build your portal with ScaleFlex to share media assets like brand guidelines, press releases, and product collections directly from the Asset Hub.\",\n \"words\":[\n {\n \"start\":15.58,\n \"end\":16.24,\n \"word\":\"Build\",\n \"probability\":1.0\n },\n {\n \"start\":16.24,\n \"end\":16.42,\n \"word\":\"your\",\n \"probability\":1.0\n },\n {\n \"start\":16.42,\n \"end\":16.8,\n \"word\":\"portal\",\n \"probability\":0.93\n },\n {\n \"start\":16.8,\n \"end\":17.02,\n \"word\":\"with\",\n \"probability\":1.0\n },\n {\n \"start\":17.02,\n \"end\":17.76,\n \"word\":\"ScaleFlex\",\n \"probability\":0.87\n },\n {\n \"start\":17.76,\n \"end\":18.1,\n \"word\":\"to\",\n \"probability\":0.91\n },\n {\n \"start\":18.1,\n \"end\":18.36,\n \"word\":\"share\",\n \"probability\":1.0\n },\n {\n \"start\":18.36,\n \"end\":18.72,\n \"word\":\"media\",\n \"probability\":1.0\n },\n {\n \"start\":18.72,\n \"end\":19.34,\n \"word\":\"assets\",\n \"probability\":1.0\n },\n {\n \"start\":19.34,\n \"end\":19.68,\n \"word\":\"like\",\n \"probability\":0.98\n },\n {\n \"start\":19.68,\n \"end\":20.02,\n \"word\":\"brand\",\n \"probability\":0.97\n },\n {\n \"start\":20.02,\n \"end\":20.6,\n \"word\":\"guidelines,\",\n \"probability\":1.0\n },\n {\n \"start\":20.98,\n \"end\":21.4,\n \"word\":\"press\",\n \"probability\":1.0\n },\n {\n \"start\":21.4,\n \"end\":21.88,\n \"word\":\"releases,\",\n \"probability\":1.0\n },\n {\n \"start\":22.1,\n \"end\":22.36,\n \"word\":\"and\",\n \"probability\":1.0\n },\n {\n \"start\":22.36,\n \"end\":22.74,\n \"word\":\"product\",\n \"probability\":1.0\n },\n {\n \"start\":22.74,\n \"end\":23.5,\n \"word\":\"collections\",\n \"probability\":1.0\n },\n {\n \"start\":23.5,\n \"end\":26.22,\n \"word\":\"directly\",\n \"probability\":0.58\n },\n {\n \"start\":26.22,\n \"end\":26.78,\n \"word\":\"from\",\n \"probability\":1.0\n },\n {\n \"start\":26.78,\n \"end\":26.92,\n \"word\":\"the\",\n \"probability\":1.0\n },\n {\n \"start\":26.92,\n \"end\":27.3,\n \"word\":\"Asset\",\n \"probability\":0.84\n },\n {\n \"start\":27.3,\n \"end\":27.6,\n \"word\":\"Hub.\",\n \"probability\":0.73\n }\n ],\n \"confidence\":0.83\n },\n {\n \"start\":28.82,\n \"end\":35.04,\n \"text\":\"And with flexible access management, this feature enhances security in a way users will love.\",\n \"words\":[\n {\n \"start\":28.82,\n \"end\":29.54,\n \"word\":\"And\",\n \"probability\":0.9\n },\n {\n \"start\":29.54,\n \"end\":29.78,\n \"word\":\"with\",\n \"probability\":0.94\n },\n {\n \"start\":29.78,\n \"end\":30.28,\n \"word\":\"flexible\",\n \"probability\":0.73\n },\n {\n \"start\":30.28,\n \"end\":30.68,\n \"word\":\"access\",\n \"probability\":0.98\n },\n {\n \"start\":30.68,\n \"end\":31.3,\n \"word\":\"management,\",\n \"probability\":1.0\n },\n {\n \"start\":31.56,\n \"end\":32.22,\n \"word\":\"this\",\n \"probability\":1.0\n },\n {\n \"start\":32.22,\n \"end\":32.52,\n \"word\":\"feature\",\n \"probability\":1.0\n },\n {\n \"start\":32.52,\n \"end\":32.96,\n \"word\":\"enhances\",\n \"probability\":1.0\n },\n {\n \"start\":32.96,\n \"end\":33.56,\n \"word\":\"security\",\n \"probability\":1.0\n },\n {\n \"start\":33.56,\n \"end\":33.82,\n \"word\":\"in\",\n \"probability\":0.99\n },\n {\n \"start\":33.82,\n \"end\":33.94,\n \"word\":\"a\",\n \"probability\":1.0\n },\n {\n \"start\":33.94,\n \"end\":34.08,\n \"word\":\"way\",\n \"probability\":1.0\n },\n {\n \"start\":34.08,\n \"end\":34.42,\n \"word\":\"users\",\n \"probability\":1.0\n },\n {\n \"start\":34.42,\n \"end\":34.66,\n \"word\":\"will\",\n \"probability\":1.0\n },\n {\n \"start\":34.66,\n \"end\":35.04,\n \"word\":\"love.\",\n \"probability\":1.0\n }\n ],\n \"confidence\":0.9\n },\n {\n \"start\":37.04,\n \"end\":39.54,\n \"text\":\"Visit our website to discover more.\",\n \"words\":[\n {\n \"start\":37.04,\n \"end\":37.76,\n \"word\":\"Visit\",\n \"probability\":1.0\n },\n {\n \"start\":37.76,\n \"end\":37.98,\n \"word\":\"our\",\n \"probability\":1.0\n },\n {\n \"start\":37.98,\n \"end\":38.4,\n \"word\":\"website\",\n \"probability\":0.99\n },\n {\n \"start\":38.4,\n \"end\":38.7,\n \"word\":\"to\",\n \"probability\":1.0\n },\n {\n \"start\":38.7,\n \"end\":39.14,\n \"word\":\"discover\",\n \"probability\":1.0\n },\n {\n \"start\":39.14,\n \"end\":39.54,\n \"word\":\"more.\",\n \"probability\":1.0\n }\n ],\n \"confidence\":0.9\n }\n ]\n },\n \"request_uuid\":\"e11bf0d5-c88e-41f0-a86c-de6d3e00b5a9\",\n \"sha1\":\"776d1bc8a31b3eae86fceb0b8ea429e12e33e05d\",\n \"file_downloaded\":\"portals.mp4\",\n \"file_downloaded_in\":1.18\n}"},{"id":"e51d2914-ece7-45a8-8916-e8221162dd5f","name":"Video transcription (srt) URL","originalRequest":{"method":"GET","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","type":"text"}],"url":{"raw":"{{ask-filerobot-server}}/videos/video-transcription/:url?srt=true","host":["{{ask-filerobot-server}}"],"path":["videos","video-transcription",":url"],"query":[{"key":"confidence","value":"0.5","description":"Removes text segments from the response if their confidence is lower than this value","type":"text","disabled":true},{"key":"word_timestamps","value":"true","description":"Includes additional information for each word in the returned text segments","disabled":true},{"key":"srt","value":"true","description":"Formats the transcription output as an SRT file (a readable subtitle format that includes both text and timing details). The SRT content is included in the response under the key `srt`."}],"variable":[{"key":"url","value":"https://try.filerobot.com/trpakov/portals.mp4","description":"Url of the video to process"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 04 Apr 2025 10:11:32 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 5893c71b6cde828b408a700f9c0673b0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD50-C2"},{"key":"X-Amz-Cf-Id","value":"5FSPNP3-rFGGXg4P_v0tAPNwy9rY7_JX_jCmsbQvRSpagXd9wwsF7Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"3.20.0\",\n \"source\": \"cache-file\",\n \"sha1\": \"776d1bc8a31b3eae86fceb0b8ea429e12e33e05d\",\n \"transcription\": {\n \"language\": \"en\",\n \"segments\": [\n {\n \"start\": 0.0,\n \"end\": 8.0,\n \"text\": \"Welcome to Portals, the ultimate dam extension for fluid brand management.\",\n \"confidence\": 0.83\n },\n {\n \"start\": 8.0,\n \"end\": 15.0,\n \"text\": \"Embrace unified brand identity with our intuitive and customizable templates.\",\n \"confidence\": 0.83\n },\n {\n \"start\": 15.0,\n \"end\": 27.0,\n \"text\": \"Build your portal with ScaleFlex to share media assets like brand guidelines, press releases, and product collections directly from the Asset Hub.\",\n \"confidence\": 0.83\n },\n {\n \"start\": 27.0,\n \"end\": 37.0,\n \"text\": \"And with flexible access management, this feature enhances security in a way users will love.\",\n \"confidence\": 0.89\n },\n {\n \"start\": 37.0,\n \"end\": 40.0,\n \"text\": \"Visit our website to discover more.\",\n \"confidence\": 0.89\n }\n ],\n \"srt\": \"1\\n00:00:00,000 --> 00:00:08,000\\nWelcome to Portals, the ultimate dam extension for fluid brand management.\\n\\n2\\n00:00:08,000 --> 00:00:15,000\\nEmbrace unified brand identity with our intuitive and customizable templates.\\n\\n3\\n00:00:15,000 --> 00:00:27,000\\nBuild your portal with ScaleFlex to share media assets like brand guidelines, press releases, and product collections directly from the Asset Hub.\\n\\n4\\n00:00:27,000 --> 00:00:37,000\\nAnd with flexible access management, this feature enhances security in a way users will love.\\n\\n5\\n00:00:37,000 --> 00:00:40,000\\nVisit our website to discover more.\\n\\n\"\n },\n \"request_uuid\": \"39fc7f35-4491-4c46-9b44-e864a56ca210\",\n \"file_downloaded\": \"portals.mp4\",\n \"file_downloaded_in\": 0.26\n}"}],"_postman_id":"4dc073dc-f83f-4797-84cb-69f58ba7cae2"}],"id":"68b92aee-c5a7-4861-9eb6-088f50f9ce5b","description":"Endpoints that process the audio of the input video file and return a transcription of the detected spoken content.
\nFor the moment this feature is limited to a maximum of 50 MB video size.
\n","_postman_id":"68b92aee-c5a7-4861-9eb6-088f50f9ce5b"}],"id":"bf4e02a4-c449-4583-968d-a5c7f4410dc2","description":"The following APIs only support videos.
\n","_postman_id":"bf4e02a4-c449-4583-968d-a5c7f4410dc2"},{"name":"Bulk operations","item":[{"name":"Bulk operations Multipart","id":"111775ce-d339-4b51-b209-ca9d41224917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file
\n","type":"file","src":"frasVnEkx/face.png"},{"key":"postprocess","value":"face-count,dominant-color","type":"text"}]},"url":"{{ask-filerobot-server}}/images/bulk/upload","urlObject":{"path":["images","bulk","upload"],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"7b126f55-89e0-4375-9ff9-22326bd2d8c9","name":"Bulk operations Multipart","originalRequest":{"method":"POST","header":[{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"local file","type":"file","src":"RnbvOEZru/face.png"},{"key":"postprocess","value":"face-count,dominant-color","type":"text","description":"A list of process names to be executed."}]},"url":"{{ask-filerobot-server}}/images/bulk/upload"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Aug 2023 08:49:36 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"1189"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"results\": [\n {\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"faces_num\": 1,\n \"message\": \"Only one face found.\",\n \"file_downloaded_in\": 0.19,\n \"request_uuid\": \"ea194c4b-511a-41e5-8d73-f9a5a86122d2\"\n },\n {\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"b5d07a2d7648df181c94b2e2c8616ff7a91ca8c0\",\n \"request_uuid\": \"6879d914-7527-4fe1-ac55-bb99e94d6824\",\n \"url_downloaded\": \"http://sample.li/face.png\",\n \"file_downloaded_in\": 0.19,\n \"dominant_colors\": [\n {\n \"color\": \"pink\",\n \"pixels\": 194956,\n \"ratio\": 0.13,\n \"all\": 1484032\n },\n {\n \"color\": \"yellow\",\n \"pixels\": 98320,\n \"ratio\": 0.07,\n \"all\": 1484032\n }\n ],\n \"main_colors\": [\n \"pink\",\n \"yellow\",\n \"grass green\"\n ],\n \"main_colors_ratio\": [\n 0.13,\n 0.07,\n 0.05\n ],\n \"main_colors_pixels\": [\n 194956,\n 98320,\n 68663\n ]\n }\n ]\n}"}],"_postman_id":"111775ce-d339-4b51-b209-ca9d41224917"},{"name":"Bulk operations URL","id":"ce4965ad-a44a-4d19-8d7f-f583f4c72d86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"postprocess\": [\n \"dominant-color\",\n \"face-count\"\n ],\n \"urls\": [\n \"http://sample.li/tesla.jpg\"\n ]\n}"},"url":"{{ask-filerobot-server}}/images/bulk","urlObject":{"path":["images","bulk"],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[]}},"response":[{"id":"90fc682c-a079-434e-8d87-6f876ca49e4a","name":"Bulk operations URL","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token ","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"postprocess\": [\n \"dominant-color\",\n \"face_count\"\n ],\n \"urls\": [\n \"http://sample.li/tesla.jpg\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{ask-filerobot-server}}/images/bulk"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 01 Aug 2023 08:48:24 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"948"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"results\": [\n {\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"cc9a4427c90ba5881e5be8d3521724cfcfc9f5b8\",\n \"request_uuid\": \"792db155-4713-4e50-9466-1eb522f9f37a\",\n \"url_downloaded\": \"http://sample.li/tesla.jpg\",\n \"file_downloaded_in\": 0.44,\n \"dominant_colors\": [\n {\n \"color\": \"chartreuse\",\n \"pixels\": 3586668,\n \"ratio\": 0.16,\n \"all\": 22118400\n },\n {\n \"color\": \"yellow\",\n \"pixels\": 2433373,\n \"ratio\": 0.11,\n \"all\": 22118400\n }\n ]\n },\n {\n \"status\": \"success\",\n \"version\": \"2.9.4\",\n \"source\": \"cache-file\",\n \"sha1\": \"cc9a4427c90ba5881e5be8d3521724cfcfc9f5b8\",\n \"faces_num\": 0,\n \"message\": \"No faces found.\",\n \"file_downloaded_in\": 0.44,\n \"request_uuid\": \"7b8270be-8a9a-4a6f-98d5-d48fd3d5e603\"\n }\n ]\n}"}],"_postman_id":"ce4965ad-a44a-4d19-8d7f-f583f4c72d86"}],"id":"84b1d4fb-5210-4809-a0cd-0f7346305ddf","description":"The Bulk operations endpoints allow you to execute multiple operations and apply multiple ML models to agiven image in one API call.
\n","_postman_id":"84b1d4fb-5210-4809-a0cd-0f7346305ddf"},{"name":"Beta","item":[{"name":"Product classification","id":"c675be70-3af4-4bde-b9fd-b16643b9698c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Filerobot-Token","value":"{{Filerobot-Token}}","description":"Filerobot project identifier, aka token
\n","type":"text"},{"key":"Filerobot-Key","value":"{{Filerobot-Key}}","description":"Filerobot API key
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ask-filerobot-server}}/images/product-type-classification/:url","urlObject":{"path":["images","product-type-classification",":url"],"host":["{{ask-filerobot-server}}"],"query":[],"variable":[{"type":"any","value":"http://sample.li/alps.jpg","key":"url"}]}},"response":[],"_postman_id":"c675be70-3af4-4bde-b9fd-b16643b9698c"}],"id":"62f2ce1c-393e-49b5-a8ab-af12f8c786fb","_postman_id":"62f2ce1c-393e-49b5-a8ab-af12f8c786fb","description":""}],"id":"34ab092e-2682-463c-a187-9106b6a02cc2","description":"Visual AI APIs for:
\n- \n
Classification APIs
\n
Data enrichment / classification, e.g. automatically detect objects and tag images \nModeration APIs
\n
Content moderation, e.g. block user-generated images containing explicit content, warn if non-compliant images are uploaded \nGenerative API
\n
Generate derivatives, e.g. remove/replace background, blur number plate \n
And many more.
\nSome of the ASK Filerobot capabilities can be viewed on the Demo page:
\nTo use these APIs, you will need to obtain your Filerobot-API-Key from the Filerobot Asset Hub admin, under the section Settings > Development > API keys.
\nMake sure that the key you choose has the FILE_UPLOAD permission enabled, in order to use it with the ASK APIs.
\n\nThe Demo environment provided with this collection is for demo purposes only and does not contain actual variable values .
\n
\n\nThe ASK Filerobot Visual AI APIs do not require you to upload your assets into Filerobot DAM. You can provide the asset as a lnk to a 3rd party server or application hosting the origin images or upload them via Multipart upload with the API calls.
\n
Note about integration
\nAll request examples you will find in this documentation are synchronous calls to our API. They will help you to understand our response formats and help you to assess the quality of our models. However we strongly recommend that you integrate our API using the asynchronous mode. The reason is that our servers have throttle limitations to avoid being overflowed.
\nAsynchronous requests will not give you the response directly but will give you an URL that returns the status of the task and the final results when they are ready.
\nTo use the asynchronous mode add the following query parameter to your request :
\nmode=async\n\nHere is an example of an asynchronous request :
\ncurl --location 'https://ai.scaleflex.com/images/image-to-text/http://sample.li/face.png?mode=async&cache=false' \\\n --header 'Content-Type: application/json' \\\n --header 'Filerobot-Token: fdocs' \\\n --header 'Filerobot-Key: ***'\n\nHere is the response of the asynchronous request:
\n{\n \"status\":\"https://ai.scaleflex.com/status/ZXUtb3YtMTAzLm5vZG/e893135b-0d37-49d9-98f6-e00ed0bc391c\",\n \"version\":\"3.29.0\"\n}\n\nHere is the response of the status URL before the task is finished :
\n{\n \"status\":\"processing\",\n \"version\":\"3.29.0\",\n}\n\nHere is the response of the status URL after the task is finished :
\n{\n \"status\":\"success\",\n \"version\":\"3.29.0\",\n \"result\":{\n \"request_uuid\":\"e3958e8b-356d-4879-9429-8c1f560e60fe\",\n \"file_downloaded\":\"face.png\",\n \"sha1\":\"0ac549bb6b0af5213b91fe706cec208e1c8b120d\",\n \"image_to_text\":\"The image shows a young woman with long, reddish-brown hair and freckles. She is looking directly at the camera with a slight smile. She is wearing a gray shirt and a light-colored coat. The background is blurred, with hints of green foliage and a bridge or railing. The overall impression is one of natural beauty and a calm, pleasant atmosphere.\",\n \"translations\":{\n \"en\":\"The image shows a young woman with long, reddish-brown hair and freckles. She is looking directly at the camera with a slight smile. She is wearing a gray shirt and a light-colored coat. The background is blurred, with hints of green foliage and a bridge or railing. The overall impression is one of natural beauty and a calm, pleasant atmosphere.\"\n },\n \"finished_in\":1.6\n }\n}\n\nAsynchronous Usage Example :
\nHere you will find an example on how to use Visual AI api in asynchronous mode. The following script is a basic implementation of a producer/consumer mechanism :
\n- \n
producer : sends asynchronous requests to Visual AI api
\n \nconsumer : periodically checks for result of the asynchronous task
\n \n
As you can see producers and consumers use thread pools of 8 threads, this to ensure high-speed parallel processing but still is reasonable throughput to avoid requests being rejected by our firewall.
\nimport concurrent.futures\nimport queue\nimport threading\nimport time\nimport requests\nFILEROBOT_TOKEN = \"***\" # Account token\nFILEROBOT_KEY = \"***\" # Account api key\nHOST = \"https://ai.scaleflex.com\"\nENDPOINT = \"images/image-to-text/\"\nHEADERS = {\"Filerobot-Token\": FILEROBOT_TOKEN, \"Filerobot-Key\": FILEROBOT_KEY}\nURL = f\"{HOST}/{ENDPOINT}\"\nBIG_BANG = time.time()\nRESULTS_DICT = {}\nurl_queue = queue.Queue()\ndict_lock = threading.Lock()\nALL_URLS = [\n \"https://api.filerobot.com/try/v5/get/be794de4-dc5c-50d6-819a-091388a50000\",\n \"https://api.filerobot.com/try/v5/get/2901edf0-814e-598b-a93e-7e932bc50000\",\n \"https://api.filerobot.com/try/v5/get/73bf3e51-e31f-5a13-917a-eb0746850000\",\n \"https://api.filerobot.com/try/v5/get/2cb261a4-5da0-5e43-8bc3-b49a27550000\",\n \"https://api.filerobot.com/try/v5/get/bc17e5b1-0489-57cc-a111-e9ce88850000\",\n \"https://api.filerobot.com/try/v5/get/ea4d8995-533b-5fb6-938d-167bf2b50000\",\n \"https://api.filerobot.com/try/v5/get/b6a1d9aa-8bdf-5050-bf11-0e415b150000\",\n \"https://api.filerobot.com/try/v5/get/c33311c5-634d-5720-a875-ae3f62350000\",\n \"https://api.filerobot.com/try/v5/get/4edb384d-8c55-5514-8ff3-4a4315750000\",\n \"https://api.filerobot.com/try/v5/get/3ceff9ef-8198-5cb8-bfc9-e9424b350000\",\n]\ndef process_single_image(task_id: str, asset_url: str) -> None:\n params = dict(mode=\"async\", cache=False)\n url = URL + asset_url\n response = requests.get(url, timeout=60, params=params, headers=HEADERS) # Request to Visual AI server\n if response.status_code == 201:\n url = response.json().get(\"status\")\n url_queue.put((task_id, url))\n else:\n print(f\"Failed to process {asset_url}: {response.status_code}\")\ndef check_result() -> None:\n while True:\n item = url_queue.get()\n if item is None:\n url_queue.task_done()\n print(\"[Pool 2] Received shutdown signal. Exiting thread.\")\n break\n task_id, url = item\n final_result = None\n while final_result is None:\n response = requests.get(url, timeout=60, headers=HEADERS)\n response_json = response.json()\n if response_json.get(\"status\") == \"processing\":\n time.sleep(5) # Wait few seconds before checking results again\n continue\n final_result = response_json.get(\"result\")\n print(\"Results fetched, adding to final results dictionary\")\n with dict_lock:\n RESULTS_DICT[url] = final_result # Here you can persist results in files or in database\n dt = time.time() - BIG_BANG\n print(f\"{len(RESULTS_DICT)} items done in {dt} seconds\")\n url_queue.task_done()\nif __name__ == \"__main__\":\n num_consumers = 10\n num_producers = 10\n with concurrent.futures.ThreadPoolExecutor(max_workers=num_producers) as pool1, \\\n concurrent.futures.ThreadPoolExecutor(max_workers=num_consumers) as pool2:\n for _ in range(num_consumers):\n pool2.submit(check_result)\n producer_futures = [pool1.submit(process_single_image, i, url) for i, url in enumerate(ALL_URLS)]\n concurrent.futures.wait(producer_futures)\n print(\"\\n[Main] Pool 1 has finished generating all URLs. Sending shutdown signals...\\n\")\n for _ in range(num_consumers):\n url_queue.put(None)\n print(\"\\n--- All Threads Finished ---\")\n print(f\"Final Dictionary Results ({len(RESULTS_DICT)} items):\")\n for k, v in sorted(RESULTS_DICT.items()):\n print(f\"Task {k}: {v}\")\n\nWarms up assets in the Cloudimage CDN with transformations.
\nUp to 5 Million URLs can be warmed up per day as JSON body or CSV file with the format below.
We recommend to run up to 1M URLs per batch and to run them every other hour.
Contact us if you need to warm up higher volumes.
<a class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' href=\"https://www.cloudimage.io/en/contact-us\" target=\"_blank\" url=\"https://www.cloudimage.io/en/contact-us\">Contact us</a>http://sample.li/logo-cloudimg-black.png?w=200\n/logo-cloudimg-white.png?w=200\n/logo-cloudimg-yellow.png?w=200\n/hotel.jpg?pixellate=5\n/house.jpg?pixellate=5\n/eye.jpg?w=500&h=280\n\n⚠️ Note: Protocol and domain must be removed (e.g. https:sample.li/car.jpg?w=800)
⚠️ Note: you need to provide a transformation (with query parameters) to warm up images.
You can load your assets (images, videos, static files, JS/CSS code, ...) into the Cloudimage CDN cache via the warm-up API.
\nWarm up is a service for customers with large volume of images who want to make sure the images are fully ingested, resized and compressed before their first publishing to end users.
\n","_postman_id":"dfceb5ba-641d-49ee-993c-d789310b1b0e"},{"name":"Invalidation (flush)","item":[{"name":"Invalidate","id":"46c23482-e48d-413c-8aa2-f51a6de02dfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Client-Key","value":"{{Cloudimage-API-Key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"original\",\n \"urls\": [\n \"http://sample.li/birds.jpg\",\n \"http://sample.li/car.jpg\"\n ]\n}"},"url":"https://api.cloudimage.com/invalidate","description":"scope
- \n
- original: invalidates original image and all transformations. \n
- all: invalidate the entire cache. Only use this scope if you know what you are doing ⚠️⚠️⚠️. \n
This endpoint will return an invalidation.uuid that can be used for checking the status or restarting the invalidation task.
Statuses:
\n- \n
- RECEIVED: the request is received. \n
- PREPARING: the system prepares to start the invalidation process \n
- FLUSHING_CLOUDIMAGE_SERVER: the cache stored in the Cloudimage infra is flushing \n
- FLUSHING_CDN_SERVERS: the cache of the CDN servers around the world is flushing \n
- DONE: the invalidation is completed \n
- ERROR: an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, contact our Support team for help. \n
Statuses:
\n- \n
- RECEIVED -> the request is received. \n
- PREPARING -> the system prepares to start the invalidation process \n
- FLUSHING_CLOUDIMAGE_SERVER -> the cache stored in the Cloudimage infra is flushing \n
- FLUSHING_CDN_SERVERS -> the cache of the CDN servers around the world is flushing \n
- DONE -> the invalidation is completed \n
- ERROR -> an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, contact the Support team for help. \n
After performing invalidation request, the API response will contain the invalidation_uuid of your task
\n","type":"text/plain"},"type":"any","value":"{{invalidation-uuid}}","key":"invalidation_uuid"}]}},"response":[{"id":"da718230-37c6-4342-826c-e8647c274af6","name":"Invalidation status","originalRequest":{"method":"GET","header":[{"key":"X-Client-Key","value":"{{Cloudimage-API-Key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.cloudimage.com/invalidate/:invalidation_uuid","protocol":"https","host":["api","cloudimage","com"],"path":["invalidate",":invalidation_uuid"],"variable":[{"key":"invalidation_uuid","value":"{{invalidation-uuid}}","description":"After performing invalidation request, the API response will contain the invalidation_uuid of your task\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 08 Aug 2023 13:42:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"invalidation\": {\n \"status\": \"DONE\",\n \"uuid\": \"8f988e14-24ca-4225-ae88-0e525f48ab78\",\n \"added_at\": \"2023-08-08 13:40:26.766563\",\n \"urls\": {\n \"received\": null,\n \"invalidated\": [\n \"/*\"\n ],\n \"failed\": []\n },\n \"scope\": \"all\"\n }\n}"}],"_postman_id":"97f09c24-28b7-4ae0-a97c-1466135caafd"},{"name":"Restart invalidation job","id":"3f7d16fb-b578-4d7f-8aaf-0951c83d4010","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Client-Key","value":"{{Cloudimage-API-Key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.cloudimage.com/invalidate/:invalidation_uuid/restart","description":"This endpoint can be used to RETRY (Restart) the invalidation task in case of need.
\n","urlObject":{"protocol":"https","path":["invalidate",":invalidation_uuid","restart"],"host":["api","cloudimage","com"],"query":[],"variable":[{"description":{"content":"After performing invalidation request, the API response will contain the invalidation_uuid of your task
\n","type":"text/plain"},"type":"any","value":"{{invalidation-uuid}}","key":"invalidation_uuid"}]}},"response":[{"id":"26e696af-f0b9-45bb-bb20-14168690631a","name":"Restart job","originalRequest":{"method":"POST","header":[{"key":"X-Client-Key","value":"{{Cloudimage-API-Key}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.cloudimage.com/invalidate/:invalidation_uuid/restart","protocol":"https","host":["api","cloudimage","com"],"path":["invalidate",":invalidation_uuid","restart"],"variable":[{"key":"invalidation_uuid","value":"{{invalidation-uuid}}","description":"After performing invalidation request, the API response will contain the invalidation_uuid of your task\n"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 08 Aug 2023 13:43:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"invalidation\": {\n \"status\": \"RESTARTING_INVALIDATION\",\n \"uuid\": \"8f988e14-24ca-4225-ae88-0e525f48ab78\",\n \"added_at\": \"2023-08-08 13:40:26.766563\",\n \"urls\": {\n \"received\": null,\n \"invalidated\": [\n \"/*\"\n ],\n \"failed\": []\n },\n \"scope\": \"all\"\n }\n}"}],"_postman_id":"3f7d16fb-b578-4d7f-8aaf-0951c83d4010"}],"id":"85431959-d1af-41d0-b8bb-7149b724ae28","description":"Invalidation allows to refresh the Cloudimage CDN cache when an image (or any other asset accelerated by Cloudimage) gets updated without changing the URL.
\n","_postman_id":"85431959-d1af-41d0-b8bb-7149b724ae28"}],"id":"d1f720eb-1441-4e85-aea6-836b6ba6ed00","description":"Cloudimage delivers on-the-fly resized and optimized images and videos via CDN.
\nCloudimage is not a media storage service but rather acts as a media proxy downloading the origin (pristine) images and videos from your server or any storage container (S3, Google Cloud Storage, Azure Blob, ...) and optimizing them on-the-fly. This page documents Cloudimage's Warm-up and Invalidation APIs for managing the Cloudimage cache. The full on-the-fly media ransformation API is documented below.
\n➡️ Link to Cloudimage dynamic media transformation and compression API
\nCloudimage is fully integrated into Filerobot DAM to deliver optimized images managed in the DAM.
\nTo use these APIs, you will need to obtain your Cloudimage-API-Key from the Cloudimage admin, under the Settings > CDN Invalidation section.
\n\n\n","_postman_id":"d1f720eb-1441-4e85-aea6-836b6ba6ed00"}]}The Demo environment provided with this collection is for demo purposes only and does not contain actual variable values.
\n