1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4351],{74:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>h,contentTitle:()=>p,default:()=>x,frontMatter:()=>c,metadata:()=>s,toc:()=>u});const s=JSON.parse('{"id":"api/ai-for-image/image-text-editor/flux-depth-pro-image-text-editor","title":"Flux Depth Pro - Image Text Editor","description":"Flux Depth Pro - Image Text Editor","source":"@site/docs/api/ai-for-image/image-text-editor/flux-depth-pro.mdx","sourceDirName":"api/ai-for-image/image-text-editor","slug":"/api/ai-for-image/image-text-editor/flux-depth-pro-image-text-editor","permalink":"/docs/api/ai-for-image/image-text-editor/flux-depth-pro-image-text-editor","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"flux-depth-pro-image-text-editor","title":"Flux Depth Pro - Image Text Editor","description":"Flux Depth Pro - Image Text Editor","sidebar_label":"Flux Depth Pro","custom_edit_url":null},"sidebar":"apisidebar","previous":{"title":"Flux Depth Dev","permalink":"/docs/api/ai-for-image/image-text-editor/flux-depth-dev-image-text-editor"},"next":{"title":"Flux Canny Pro","permalink":"/docs/api/ai-for-image/image-text-editor/flux-canny-pro-image-text-editor"}}');var n=r(4848),i=r(8453),d=r(1470),a=r(9365),l=r(1028),o=r(1696);const c={id:"flux-depth-pro-image-text-editor",title:"Flux Depth Pro - Image Text Editor",description:"Flux Depth Pro - Image Text Editor",sidebar_label:"Flux Depth Pro",custom_edit_url:null},p="Flux Depth Pro - Image Text Editor",h={},u=[{value:"Endpoint",id:"endpoint",level:2},{value:"Request Headers",id:"request-headers",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Prompt Object Parameters",id:"prompt-object-parameters",level:3},{value:"Code Examples",id:"code-examples",level:2},{value:"Interactive Playground",id:"interactive-playground",level:2},{value:"Response Format",id:"response-format",level:2}
1,{value:"Success Response (200)",id:"success-response-200",level:3},{value:"Use Cases",id:"use-cases",level:2},{value:"Tips for Best Results",id:"tips-for-best-results",level:2}];function m(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"flux-depth-pro---image-text-editor",children:"Flux Depth Pro - Image Text Editor"})}),"\n",(0,n.jsx)(t.p,{children:"Professional-grade depth-aware AI image editing model designed for advanced image manipulation. Flux Depth Pro specializes in understanding image depth and spatial relationships, enabling sophisticated edits that maintain proper perspective and depth cues."}),"\n",(0,n.jsx)(t.h2,{id:"endpoint",children:"Endpoint"}),"\n",(0,n.jsxs)("div",{className:"api-endpoint",children:[(0,n.jsx)("span",{className:"badge badge--success",children:"POST"}),(0,n.jsx)("code",{children:(0,n.jsx)(t.a,{href:"https://api.1min.ai/api/features",children:"https://api.1min.ai/api/features"})})]}),"\n",(0,n.jsx)(t.h2,{id:"request-headers",children:"Request Headers"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Field"}),(0,n.jsx)(t.th,{children:"Value"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"API-KEY"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"<api-key>"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Content-Type"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"application/json"})})]})]})]}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Required"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"type"})}),(0,n.jsx)(t.td,{children:"string"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsxs)(t.td,{children:["Feature type identifier. Must be ",(0,n.jsx)(t.code,{children:"IMAGE_EDITOR"})]})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"model"})}),(0,n.jsx)(t.td,{children:"string"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsxs)(t.td,{children:["AI model identifier. Must be ",(0,n.jsx)(t.code,{children:"black-forest-labs/flux-depth-pro"})]})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"promptObject"})}),(0,n.jsx)(t.td,{children:"object"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsx)(t.td,{children:"Configuration object containing all image editing parameters"})]})]})]}),"\n",(0,n.jsx)(t.h3,{id:"prompt-object-parameters",children:"Prompt Object Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Required"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Default"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"imageUrl"})}),(0,n.jsx)(t.td,{children:"string"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsx)(t.td,{children:"Path to the source image to be edited"}),(0,n.jsx)(t.td,{children:"-"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"prompt"})}),(0,n.jsx)(t.td,{children:"string"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsx)(t.td,{children:"Text description of the desired image transformation"}),(0,n.jsx)(t.td,{children:"-"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"seed"})}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"Random seed for reproducibility (0-4294967295)"}),(0,n.jsx)(t.td,{children:"0"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"steps"})}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"Number of inference steps for generation quality"}),(0,n.jsx)(t.td,{children:"28"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"prompt_upsampling"})}),(0,n.jsx)(t.td,{children:"boolean"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"Enable advanced prompt interpretation"}),(0,n.jsx)(t.td,{children:"false"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"guidance"})}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"How closely to follow the prompt (1.0-20.0)"}),(0,n.jsx)(t.td,{children:"3.5"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"safety_tolerance"})}),(0,n.jsx)(t.td,{children:"number"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"Content safety threshold (1-6)"}),(0,n.jsx)(t.td,{children:"2"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"format"})}),(0,n.jsx)(t.td,{children:"string"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"Output image format (jpg, png, webp)"}),(0,n.jsx)(t.td,{children:"jpg"})]})]})]}),"\n",(0,n.jsx)(t.h2,{id:"code-examples",children:"Code Examples"}),"\n",(0,n.jsxs)(d.A,{children:[(0,n.jsx)(a.A,{value:"curl",label:"cURL",default:!0,children:(0,n.jsx)(l.A,{language:"bash",children:'curl -X POST "https://api.1min.ai/api/features" \\\n-H "API-KEY: <api-key>" \\\n-H "Content-Type: application/json" \\\n-d \'{\n "type": "IMAGE_EDITOR",\n "model": "black-forest-labs/flux-depth-pro",\n "promptObject": {\n "imageUrl": "development/images/2025_02_16_15_42_40_711_human.jpg",\n "prompt": "Add realistic depth blur to background while keeping subject sharp",\n "seed": 42,\n "steps": 28,\n "prompt_upsampling": true,\n "guidance": 3.5,\n "safety_tolerance": 2,\n "format": "jpg"\n }\n}\''})}),(0,n.jsx)(a.A,{value:"javascript",label:"JavaScript",children:(0,n.jsx)(l.A,{language:"javascript",children:"fetch('https://api.1min.ai/api/features', {\nmethod: 'POST',\nheaders: {\n 'Content-Type': 'application/json',\n 'API-KEY': 'YOUR_API_KEY'\n},\nbody: JSON.stringify({\n type: 'IMAGE_EDITOR',\n model: 'black-forest-labs/flux-depth-pro',\n promptObject: {\n imageUrl: 'development/images/2025_02_16_15_42_40_711_human.jpg',\n prompt: 'Add realistic depth blur to background while keeping subject sharp',\n seed: 42,\n steps: 28,\n prompt_upsampling: true,\n guidance: 3.5,\n safety_tolerance: 2,\n format: 'jpg'\n }\n})\n})"})}),(0,n.jsx)(a.A,{value:"python",label:"Python",children:(0,n.jsx)(l.A,{language:"python",children:'import requests\n\nurl = "https://api.1min.ai/api/features"\nheaders = {\n"Content-Type": "application/json",\n"API-KEY": "YOUR_API_KEY"\n}\n\ndata = {\n"type": "IMAGE_EDITOR",\n"model": "black-forest-labs/flux-depth-pro",\n"promptObject": {\n "imageUrl": "development/images/2025_02_16_15_42_40_711_human.jpg",\n "prompt": "Add realistic depth blur to background while keeping subject sharp",\n "seed": 42,\n "steps": 28,\n "prompt_upsampling": True,\n "guidance": 3.5,\n "safety_tolerance": 2,\n "format": "jpg"\n}\n}\n\nresponse = requests.post(url, headers=headers, json=data)'})})]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"interactive-playground",children:"Interactive Playground"}),"\n",(0,n.jsx)(o.A,{endpoint:"/api/features",method:"POST",baseUrl:"https://api.1min.ai",defaultHeaders:{"API-KEY":"<your-api-key>","Content-Type":"application/json"},defaultBody:{type:"IMAGE_EDITOR",model:"black-forest-labs/flux-depth-pro",promptObject:{imageUrl:"development/images/2025_02_16_15_42_40_711_human.jpg",prompt:"Add realistic depth blur to background while keeping subject sharp",seed:42,steps:28,prompt_upsampling:!1,guidance:3.5,safety_tolerance:2,format:"jpg"}},parameterConfig:[{path:"model",label:"AI Model",type:"select",required:!0,options:[{label:"Flux Depth Pro",value:"black-forest-labs/flux-depth-pro"}],getValue:e=>e.model},{path:"promptObject.imageUrl",label:"Image URL",type:"text",required:!0,description:"Path to the source image to be edited",placeholder:"development/images/your_image.jpg",getValue:e=>e.promptObject?.imageUrl},{path:"promptObject.prompt",label:"Prompt",type:"textarea",required:!0,description:"Description of desired depth-aware edits",placeholder:"Add realistic depth blur to background",getValue:e=>e.promptObject?.prompt},{path:"promptObject.seed",label:"Seed",type:"number",required:!1,description:"Seed for reproducible results (0-4294967295)",placeholder:"42",min:0,max:4294967295,getValue:e=>e.promptObject?.seed},{path:"promptObject.steps",label:"Steps",type:"number",required:!1,description:"Number of inference steps (1-50)",placeholder:"28",min:1,max:50,getValue:e=>e.promptObject?.steps},{path:"promptObject.prompt_upsampling",label:"Prompt Upsampling",type:"select",options:[{label:"false",value:!1},{label:"true",value:!0}],required:!1,description:"Enhance prompt with AI",getValue:e=>e.promptObject?.prompt_upsampling}
1,{path:"promptObject.guidance",label:"Guidance",type:"number",required:!1,description:"How closely to follow prompt (1.0-20.0)",placeholder:"3.5",min:1,max:20,step:.1,getValue:e=>e.promptObject?.guidance},{path:"promptObject.safety_tolerance",label:"Safety Tolerance",type:"number",required:!1,description:"Content filtering level (1-6)",placeholder:"2",min:1,max:6,getValue:e=>e.promptObject?.safety_tolerance},{path:"promptObject.format",label:"Format",type:"select",required:!1,description:"Output image format",options:[{label:"JPEG",value:"jpg"},{label:"PNG",value:"png"},{label:"WebP",value:"webp"}],getValue:e=>e.promptObject?.format}]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"response-format",children:"Response Format"}),"\n",(0,n.jsx)(t.h3,{id:"success-response-200",children:"Success Response (200)"}),"\n",(0,n.jsx)(l.A,{language:"json",children:'{\n"aiRecord": {\n "uuid": "ac32acf4-0b2e-400e-9edf-cb3086c30a2c",\n "userId": "c937fbcc-fa8f-4565-a440-c4d87f56fcb2",\n "teamId": "a4e176b2-dabb-451e-9c58-62b451fa9630",\n "teamUser": {\n "teamId": "a4e176b2-dabb-451e-9c58-62b451fa9630",\n "userId": "c937fbcc-fa8f-4565-a440-c4d87f56fcb2",\n "userName": "John Doe",\n "userAvatar": "https://lh3.googleusercontent.com/a/ACg8ocLqgsNsHRfmWF9d-E1RvJetVsEzxNOsOg-NXWNTpMxLDPJbwELI=s96-c",\n "status": "ACTIVE",\n "role": "ADMIN",\n "creditLimit": 100000000,\n "usedCredit": 8164605,\n "createdAt": "2025-10-20T04:13:40.847Z",\n "createdBy": "SYSTEM",\n "updatedAt": "2025-10-27T05:06:17.651Z",\n "updatedBy": "SYSTEM"\n },\n "model": "black-forest-labs/flux-depth-pro",\n "type": "IMAGE_EDITOR",\n "metadata": null,\n "rating": null,\n "feedback": null,\n "conversationId": null,\n "status": "SUCCESS",\n "createdAt": "2025-10-27T08:43:17.647Z",\n "aiRecordDetail": {\n "promptObject": {\n "seed": 42,\n "steps": 28,\n "format": "jpg",\n "prompt": "Add realistic depth blur to background while keeping subject sharp",\n "imageUrl": "development/images/2025_02_16_15_42_40_711_human.jpg",\n "guidance": 3.5,\n "safety_tolerance": 2,\n "prompt_upsampling": false\n },\n "resultObject": [\n "development/images/2025_10_27_15_43_26_155_702365.jpg"\n ],\n "responseObject": {}\n },\n "additionalData": null,\n "temporaryUrl": "https://s3.us-east-1.amazonaws.com/asset.1min.ai/development/images/2025_10_27_15_43_26_155_702365.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAVRUVQEFIHSKAXGE7%2F20251027%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20251027T084331Z&X-Amz-Expires=604800&X-Amz-Signature=5a66ff004deed5654ac44a823be7c4d1c8850503cb66a4445ce745c5caec5525&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject"\n}\n}'}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"use-cases",children:"Use Cases"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Depth of field effects"}),": Create realistic bokeh and background blur"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"3D scene enhancement"}),": Add depth cues to flat images"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Portrait enhancement"}),": Professional depth-based portrait effects"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Architectural visualization"}),": Emphasize spatial relationships in buildings"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Product photography"}),": Create layered depth for compelling product shots"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Cinematic effects"}),": Apply depth-based lighting and atmosphere"]}),"\n"]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"tips-for-best-results",children:"Tips for Best Results"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Describe depth relationships"}),': "foreground sharp, background blurred", "layers of depth"']}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Use spatial terminology"}),': "near", "far", "in front of", "behind", "depth of field"']}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Higher steps for quality"}
1),": Use 35-50 steps for complex depth effects"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Adjust guidance carefully"}),": Lower values (2-4) for subtle effects, higher (5-8) for dramatic changes"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Consider lighting"}),": Depth effects work best with proper lighting cues"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Test different seeds"}),": Depth processing can vary significantly with different seeds"]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Use JPEG for efficiency"}),": Good balance of quality and file size for depth-processed images"]}),"\n"]})]})}function x(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(m,{...e})}):m(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.