{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"getimg.ai Docs","colors":{"primary":"#0966FF","light":"#0966FF","dark":"#0966FF"},"logo":{"light":"https://mintcdn.com/getimgai/sQ_MAMHmYpgBppBg/logo/light.svg?fit=max\u0026auto=format\u0026n=sQ_MAMHmYpgBppBg\u0026q=85\u0026s=cd893010c81cadbf06c761f2fe01bd70","dark":"https://mintcdn.com/getimgai/nCH2elOf3o3bWynQ/logo/dark.svg?fit=max\u0026auto=format\u0026n=nCH2elOf3o3bWynQ\u0026q=85\u0026s=e02993c99107204ee2064924c06ee541"},"favicon":"https://mintcdn.com/getimgai/6pTSAG62ode9SCSw/favicon.svg?fit=max\u0026auto=format\u0026n=6pTSAG62ode9SCSw\u0026q=85\u0026s=49c2b56bf001f6e4b917e5c21e6afe0e","api":{},"navbar":{"links":[{"href":"mailto:api@getimg.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://getimg.ai/app/developer"}},"footer":{"socials":{"x":"https://x.com/getimg_ai"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://getimg.ai/app/developer"},{"anchor":"API Keys","icon":"key","href":"https://getimg.ai/app/developer/api-keys"},{"anchor":"Models","icon":"cube","href":"https://getimg.ai/app/developer/models"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"getimgai","hasAudioNarration":false,"actualSubdomain":"getimgai","customDomains":["docs.getimg.ai"],"gitSource":{"type":"github","owner":"webrockets-dev","repo":"docs","deployBranch":"master","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"entitlements":{},"buildId":"6adf26523d6319f7be03600c","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Getting started","count":5},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"Generation","count":2},{"language":"default","tag":"Billing","count":2},{"language":"default","tag":"Models","count":2},{"language":"default","tag":"Videos","count":2},{"language":"default","tag":"Images","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"snippets/style.css","content":".nav-logo{height:20px}"}],"page":{"pagePath":"api-reference/images/generate-an-image","slug":"/api-reference/images/generate-an-image","pageMetadata":{"title":"Generate an image","description":"Generate an image and return the completed result.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/images/generations","href":"/api-reference/images/generate-an-image","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate an image and return the completed result.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Generate an image","description":"Generate an image and return the completed result.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/images/generations","href":"/api-reference/images/generate-an-image","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Images"],"operationId":"createImageGeneration","summary":"Generate an image","description":"Generate an image and return the completed result.","x-codeSamples":[{"lang":"javascript","label":"Node.js","source":"import GetimgAI from \"getimg-ai\";\n\nconst client = new GetimgAI();\n\nconst result = await client.images.generate({\n model: \"seedream-5-lite\",\n prompt: \"A cinematic portrait of a cat astronaut\",\n aspect_ratio: \"1:1\",\n resolution: \"2K\",\n output_format: \"jpeg\",\n});\n"},{"lang":"python","label":"Python","source":"from getimg import GetimgAI\n\nclient = GetimgAI()\n\nresult = client.images.generate(\n model=\"seedream-5-lite\",\n prompt=\"A cinematic portrait of a cat astronaut\",\n aspect_ratio=\"1:1\",\n resolution=\"2K\",\n output_format=\"jpeg\",\n)\n"}],"requestBody":"12977c34-e252-47fd-a0a4-642f984075f4","responses":{"200":"6f4df936-c1e9-4005-b05a-d2a2bdc728c6","400":"4fbc5078-3de3-48c2-8066-83f0035fc832","401":"6b90af52-9f6a-4493-9c00-e8eebde17b5d","402":"400be85c-7d2c-4e80-8edb-03eb15d79306","422":"5dfde290-1c56-4006-b6e3-a86cd3554678","429":"d07ea917-4ba4-48a9-9190-292d52644a9e","500":"65c828b1-fe5b-4af8-a7d7-989158223241"},"method":"post","type":"path","servers":["b7818e8d-c861-4c75-899a-8bcf80cd7f4f"],"security":["acefb13d-c24f-416f-b3b2-9bfec091364f"],"path":"/v2/images/generations","baseUrlOptions":["https://api.getimg.ai"],"title":"Generate an image","codeSamples":[{"label":"Node.js","lang":"javascript","source":"import GetimgAI from \"getimg-ai\";\n\nconst client = new GetimgAI();\n\nconst result = await client.images.generate({\n model: \"seedream-5-lite\",\n prompt: \"A cinematic portrait of a cat astronaut\",\n aspect_ratio: \"1:1\",\n resolution: \"2K\",\n output_format: \"jpeg\",\n});\n"},{"label":"Python","lang":"python","source":"from getimg import GetimgAI\n\nclient = GetimgAI()\n\nresult = client.images.generate(\n model=\"seedream-5-lite\",\n prompt=\"A cinematic portrait of a cat astronaut\",\n aspect_ratio=\"1:1\",\n resolution=\"2K\",\n output_format=\"jpeg\",\n)\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model","prompt"],"properties":{"model":{"type":"string","description":"AI model ID. See [supported models](https://getimg.ai/app/developer/models).\n","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"prompt":{"type":"string","minLength":1,"maxLength":4096,"description":"Description of the image to generate or an editing instruction.\n","isRequired":true,"uniqueKey":"prompt","typeLabel":"string"},"images":{"type":"array","maxItems":20,"items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Publicly accessible HTTPS image URL or a base64 data URL\n(`data:image/png;base64,...`). Inline formats: PNG, JPEG, and WebP.\nBare base64 is not accepted. The default decoded image limit is\n10 MiB; the entire JSON request must fit within 25 MiB. Base64 adds\napproximately 33% to the original file size.\n","minLength":1,"isRequired":true,"uniqueKey":"images.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"images.items.[INDEX]","typeLabel":"object"},"description":"Optional reference images. See [supported values by model](https://getimg.ai/app/developer/models).\n","uniqueKey":"images","typeLabel":"object[]"},"aspect_ratio":{"type":"string","description":"Optional output aspect ratio. \nSee [supported values by model](https://getimg.ai/app/developer/models).\n","uniqueKey":"aspect_ratio","typeLabel":"string"},"resolution":{"type":"string","description":"Optional output resolution.\nSee [supported values by model](https://getimg.ai/app/developer/models).\n","uniqueKey":"resolution","typeLabel":"string"},"output_format":{"type":"string","enum":["png","jpeg","webp"],"default":"jpeg","description":"Output image format.\n","uniqueKey":"output_format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"basic":{"title":"basic","value":{"model":"seedream-5-lite","prompt":"A cinematic portrait of a cat astronaut","aspect_ratio":"1:1","resolution":"2K","output_format":"jpeg"}},"with_reference":{"title":"with_reference","value":{"model":"seedream-5-lite","prompt":"Product photo in warm studio lighting","images":[{"url":"https://assets.example.com/reference-1.png"}],"aspect_ratio":"16:9","resolution":"2K","output_format":"webp"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6f4df936-c1e9-4005-b05a-d2a2bdc728c6":{"description":"Image generation completed.","headers":{"Deprecation":{"description":"Sent when the requested model is deprecated (RFC 9745). The value is the deprecation date as a Unix timestamp prefixed with `@`.\n","schema":{"type":"string"},"example":"@1793491200"},"Sunset":{"description":"Sent when the requested model is deprecated and has a retirement date (RFC 8594). After this date, generations with the model fail with `invalid_parameter`.\n","schema":{"type":"string"},"example":"Mon, 01 Feb 2027 00:00:00 GMT"},"Link":{"description":"Sent when the requested model is deprecated. Links the migration guide (`rel=\"deprecation\"`) and, when one is set, the replacement model (`rel=\"successor-version\"`).\n","schema":{"type":"string"},"example":"\u003chttps://docs.getimg.ai/guides/model-deprecations>; rel=\"deprecation\", \u003c/v2/models/seedream-5-pro>; rel=\"successor-version\""},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"}},"content":{"application/json":{"schema":{"type":"object","required":["id","status","model","data","usage"],"properties":{"id":{"type":"string","description":"The ID of the generation request.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","const":"completed","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"model":{"type":"string","description":"The model used for the generation.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"data":{"type":"array","description":"The media items for the generation.","items":{"type":"object","required":["url","mime_type","deletes_at"],"properties":{"url":{"type":"string","description":"Signed temporary download URL.","isRequired":true,"uniqueKey":"data.items.[INDEX].url","typeLabel":"string"},"mime_type":{"type":"string","description":"The MIME type of the image.","isRequired":true,"uniqueKey":"data.items.[INDEX].mime_type","typeLabel":"string"},"deletes_at":{"type":"string","format":"date-time","description":"The date and time the image will be deleted.","isRequired":true,"uniqueKey":"data.items.[INDEX].deletes_at","typeLabel":"string\u003cdate-time>"},"width":{"oneOf":[{"type":"integer","description":"The width of the image in pixels.","uniqueKey":"data.items.[INDEX].width.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The width of the image in pixels.","uniqueKey":"data.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","description":"The height of the image in pixels.","uniqueKey":"data.items.[INDEX].height.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The height of the image in pixels.","uniqueKey":"data.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].height","typeLabel":"integer | null"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"usage":{"type":"object","required":["total_cost","billable_unit","unit_price","quantity"],"properties":{"total_cost":{"type":"number","description":"Total cost of the generation.","isRequired":true,"uniqueKey":"usage.total_cost","typeLabel":"number"},"billable_unit":{"type":"string","description":"The unit of the cost.","isRequired":true,"uniqueKey":"usage.billable_unit","typeLabel":"string"},"unit_price":{"type":"number","description":"The price of the unit.","isRequired":true,"uniqueKey":"usage.unit_price","typeLabel":"number"},"quantity":{"type":"number","description":"The quantity of the generation.","isRequired":true,"uniqueKey":"usage.quantity","typeLabel":"number"}},"isRequired":true,"uniqueKey":"usage","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"completed":{"title":"completed","value":{"id":"req-01HXYZABCD1234","status":"completed","model":"seedream-5-lite","data":[{"url":"https://api.getimg.ai/v2/downloads/req-01HXYZABCD1234/0?exp=1760000000\u0026sig=1d9c2f6f4f7f6c03e5c58a4e6fd8b5b8e2d0c2f5f9e1a4cfe8c0e9d9a8b7c6d5","width":2048,"height":2048,"mime_type":"image/jpeg","deletes_at":"2026-09-09T12:30:00.000Z"}],"usage":{"total_cost":0.14,"billable_unit":"image","unit_price":0.14,"quantity":1}}}},"exampleType":"examples"}},"exampleType":"examples"},"4fbc5078-3de3-48c2-8066-83f0035fc832":{"description":"The request payload or parameters are invalid.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","param","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","const":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","enum":["invalid_api_key","parameter_missing","invalid_parameter","quota_exceeded","rate_limit","content_policy_violation","not_found","server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_parameter":{"title":"invalid_parameter","value":{"error":{"message":"Unsupported resolution '8K' for model 'seedream-5-lite'.","type":"invalid_request_error","param":"resolution","code":"invalid_parameter"}}},"parameter_missing":{"title":"parameter_missing","value":{"error":{"message":"Required parameter 'prompt' is missing.","type":"invalid_request_error","param":"prompt","code":"parameter_missing"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6b90af52-9f6a-4493-9c00-e8eebde17b5d":{"description":"Authentication failed due to a missing or invalid API key.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","param","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","const":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","enum":["invalid_api_key","parameter_missing","invalid_parameter","quota_exceeded","rate_limit","content_policy_violation","not_found","server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_api_key":{"title":"invalid_api_key","value":{"error":{"message":"Incorrect API key provided. You can manage your API keys at https://getimg.ai/app/developer/api-keys","type":"invalid_request_error","param":null,"code":"invalid_api_key","doc_url":"https://docs.getimg.ai/guides/authentication"}}}},"exampleType":"examples"}},"exampleType":"examples"},"400be85c-7d2c-4e80-8edb-03eb15d79306":{"description":"Your account or project quota is insufficient for this request.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","param","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","const":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","enum":["invalid_api_key","parameter_missing","invalid_parameter","quota_exceeded","rate_limit","content_policy_violation","not_found","server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"quota_exceeded":{"title":"quota_exceeded","value":{"error":{"message":"Quota exceeded.","type":"invalid_request_error","param":null,"code":"quota_exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"},"5dfde290-1c56-4006-b6e3-a86cd3554678":{"description":"The prompt or input images failed content policy checks.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","param","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","const":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","enum":["invalid_api_key","parameter_missing","invalid_parameter","quota_exceeded","rate_limit","content_policy_violation","not_found","server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"moderated":{"title":"moderated","value":{"error":{"message":"Image or text contains sensitive content.","type":"invalid_request_error","param":null,"code":"content_policy_violation"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d07ea917-4ba4-48a9-9190-292d52644a9e":{"description":"A rate or concurrency limit was exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"},"Retry-After":{"description":"Number of seconds to wait before retrying.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"42"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","param","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","const":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","enum":["invalid_api_key","parameter_missing","invalid_parameter","quota_exceeded","rate_limit","content_policy_violation","not_found","server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rate_limited":{"title":"rate_limited","value":{"error":{"message":"Too many requests hit the API too quickly.","type":"invalid_request_error","param":null,"code":"rate_limit"}}}},"exampleType":"examples"}},"exampleType":"examples"},"65c828b1-fe5b-4af8-a7d7-989158223241":{"description":"An unexpected server error occurred.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"60"},"X-RateLimit-Remaining":{"description":"Remaining requests in the current rate-limit window.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"59"},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds) when the current rate-limit window resets.","schema":{"type":"string","pattern":"^[0-9]+$"},"example":"1760000042"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","param","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","const":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","enum":["invalid_api_key","parameter_missing","invalid_parameter","quota_exceeded","rate_limit","content_policy_violation","not_found","server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"server_error":{"title":"server_error","value":{"error":{"message":"Something went wrong on our end.","type":"invalid_request_error","param":null,"code":"server_error"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"acefb13d-c24f-416f-b3b2-9bfec091364f":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Send your API key as a bearer token:\n`Authorization: Bearer sk_\u003csecret>`.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b7818e8d-c861-4c75-899a-8bcf80cd7f4f":{"url":"https://api.getimg.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Send your API key as a bearer token:\n`Authorization: Bearer sk_\u003csecret>`.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send your API key as a bearer token:\n`Authorization: Bearer sk_\u003csecret>`.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"getimgai","siteName":"getimg.ai Docs","title":"Generate an image - getimg.ai Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T10:07:17.768Z","originalFileLocation":"api-reference/images/generate-an-image.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Generate an image and return the completed result.\">\u003cmeta data-mint-head name=\"application-name\" content=\"getimg.ai Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Generate an image - getimg.ai Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate an image and return the completed result.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"getimg.ai Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getimg.ai/api-reference/images/generate-an-image\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://getimgai.mintlify.site/_mintlify/api/og/v2?division=Images\u0026amp;title=Generate+an+image\u0026amp;description=Generate+an+image+and+return+the+completed+result.\u0026amp;theme=6364abfba0b70d5806b33364\u0026amp;signature=17e0649bed565a5718d50d1ca4bc243657dc27a8eabcee2e86e4396f9e48126a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Generate an image - getimg.ai Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate an image and return the completed result.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getimgai.mintlify.site/_mintlify/api/og/v2?division=Images\u0026amp;title=Generate+an+image\u0026amp;description=Generate+an+image+and+return+the+completed+result.\u0026amp;theme=6364abfba0b70d5806b33364\u0026amp;signature=17e0649bed565a5718d50d1ca4bc243657dc27a8eabcee2e86e4396f9e48126a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/getimgai/FU3VAiwxVCzl_fxg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"getimg.ai Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0966FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getimg.ai/api-reference/images/generate-an-image\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/images/generate-an-image.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getimg.ai/#organization\",\"name\":\"getimg.ai Docs\",\"url\":\"https://docs.getimg.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/getimgai/sQ_MAMHmYpgBppBg/logo/light.svg?fit=max\u0026auto=format\u0026n=sQ_MAMHmYpgBppBg\u0026q=85\u0026s=cd893010c81cadbf06c761f2fe01bd70\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getimg.ai#website\",\"name\":\"getimg.ai Docs\",\"url\":\"https://docs.getimg.ai\",\"publisher\":{\"@id\":\"https://docs.getimg.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getimg.ai/api-reference/images/generate-an-image#webpage\",\"url\":\"https://docs.getimg.ai/api-reference/images/generate-an-image\",\"name\":\"Generate an image\",\"description\":\"Generate an image and return the completed result.\",\"dateModified\":\"2026-10-26T10:07:17.768Z\",\"isPartOf\":{\"@id\":\"https://docs.getimg.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getimg.ai/api-reference/images/generate-an-image#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getimg.ai/api-reference/images/generate-an-image#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"getimg.ai Docs\",\"item\":\"https://docs.getimg.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Generate an image\",\"item\":\"https://docs.getimg.ai/api-reference/images/generate-an-image\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getimg.ai/api-reference/images/generate-an-image#apireference\",\"headline\":\"Generate an image\",\"name\":\"Generate an image\",\"description\":\"Generate an image and return the completed result.\",\"url\":\"https://docs.getimg.ai/api-reference/images/generate-an-image\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getimg.ai/api-reference/images/generate-an-image#webpage\"},\"dateModified\":\"2026-10-26T10:07:17.768Z\",\"publisher\":{\"@id\":\"https://docs.getimg.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getimg.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"getimg.ai Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"getimg.ai Docs","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://getimg.ai/app/developer"},{"anchor":"API Keys","icon":"key","href":"https://getimg.ai/app/developer/api-keys"},{"anchor":"Models","icon":"cube","href":"https://getimg.ai/app/developer/models"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Images","pages":[{"title":"Generate an image","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/images/generations","href":"/api-reference/images/generate-an-image"}]},{"group":"Models","pages":[{"title":"List supported models","description":"List the models available to your project with their supported parameters and pricing. Deprecated models are included with their deprecation dates. Retired models are not listed.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/models","href":"/api-reference/models/list-supported-models"},{"title":"Get a model","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/models/{model}","href":"/api-reference/models/get-a-model"}]},{"group":"Videos","pages":[{"title":"Create a video generation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/videos/generations","href":"/api-reference/videos/create-a-video-generation"},{"title":"Retrieve video generation status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/videos/generations/{id}","href":"/api-reference/videos/retrieve-video-generation-status"}]},{"group":"Billing","pages":[{"title":"Get the current balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/billing/balance","href":"/api-reference/billing/get-the-current-balance"},{"title":"Get daily costs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/billing/costs","href":"/api-reference/billing/get-daily-costs"}]}]}]},"basePath":"","title":"Generate an image - getimg.ai Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}