Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".
draft - the project was created but has not been submitted for rendering
queued - the job is waiting for an available server
rendering - the job is being processed; the image.started webhook event fires when rendering begins
complete - the job finished successfully; fires image.completed
error - the job failed during processing; fires image.errored
canceled - the job was manually canceled (for example from the Magic Hour web app)
Note:rendering, complete, and error have matching webhook events; canceled does not - a canceled job emits no webhook event, so poll this endpoint to detect cancellation.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Magic Hour API Docs","description":"Easily generate videos, images, and audio using Magic Hour's API. Follow our documentation to seamlessly integrate AI content creation into your applications.","colors":{"primary":"#3b82f6","light":"#0564ff","dark":"#3b82f6"},"logo":{"light":"https://mintcdn.com/magichour/5sgGJpuuipkw5s5v/icons/logo-light.svg?fit=max\u0026auto=format\u0026n=5sgGJpuuipkw5s5v\u0026q=85\u0026s=1f167e30baf11927bc2e0932411e455b","dark":"https://mintcdn.com/magichour/5sgGJpuuipkw5s5v/icons/logo-dark.svg?fit=max\u0026auto=format\u0026n=5sgGJpuuipkw5s5v\u0026q=85\u0026s=15c8bda28931ac4e1e2fab2c0ba6f0d5"},"favicon":"https://mintcdn.com/magichour/kbUwXh9ksnVyRSci/icons/favicon.png?fit=max\u0026auto=format\u0026n=kbUwXh9ksnVyRSci\u0026q=85\u0026s=c4fda903b24dd7067dadd1bb75508987","appearance":{"default":"dark","strict":false},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:support@magichour.ai","label":"Support"}],"primary":{"type":"button","label":"Get API key","href":"https://magichour.ai/developer?tab=api-keys\u0026ref=docs-navbar\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=navbar"}},"footer":{"socials":{"website":"https://magichour.ai/?utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=footer","x":"https://x.com/magichourai","github":"https://github.com/magichourhq","linkedin":"https://linkedin.com/company/magichour","instagram":"https://instagram.com/magichourai","youtube":"https://youtube.com/@magichourai"}},"seo":{"metatags":{"og:image":"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg","twitter:image":"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg"}},"integrations":{"ga4":{"measurementId":"G-CZ9Q9NBZB3"},"posthog":{"apiKey":"phc_EmzSy2RU0TOPhpouazMzxFedNdMyhze8HakyjffW2Wr","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["chatgpt","claude","perplexity","mcp","cursor","vscode","copy","view"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"API quickstart","icon":"forward-fast","href":"/get-started/quick-start"},{"anchor":"API pricing","icon":"credit-card","href":"/billing/overview"},{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/JX5rgsZaJp"},{"anchor":"Status","icon":"wave-pulse","href":"https://status.magichour.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"magichour","hasAudioNarration":false,"actualSubdomain":"magichour","customDomains":["docs.magichour.ai"],"gitSource":{"type":"github","owner":"magichourhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae9963236175fbf71247a24","collectionId":"c85fb09f-7763-477b-9df8-9140aa6bed33","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9963236175fbf71247a24"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae9963236175fbf71247a24","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Documentation","count":97},{"language":"default","tag":"Integration","count":56},{"language":"default","tag":"API Reference","count":45},{"language":"default","tag":"Tools","count":30},{"language":"default","tag":"Image Projects","count":16},{"language":"default","tag":"Video Projects","count":16},{"language":"default","tag":"Images","count":15},{"language":"default","tag":"Video","count":12},{"language":"default","tag":"Webhook Reference","count":10},{"language":"default","tag":"Get Started","count":7}]},"assistantConfig":{},"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar,#table-of-contents-content{scrollbar-width:thin;scrollbar-gutter:none;scrollbar-color:gray transparent}"}],"page":{"pagePath":"api-reference/image-projects/get-image-details","slug":"/api-reference/image-projects/get-image-details","pageMetadata":{"title":"Get image details","description":"Check the progress of a image project. The `downloads` field is populated after a successful render.\n \n**Statuses**\n- `queued` — waiting to start\n- `rendering` — in progress\n- `complete` — ready; see `downloads`\n- `error` — a failure occurred (see `error`)\n- `canceled` — user canceled\n- `draft` — not used","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/image-projects/{id}","href":"/api-reference/image-projects/get-image-details","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Check the progress of a image project. The \", _jsx(_components.code, {\n children: \"downloads\"\n }), \" field is populated after a successful render.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Statuses\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"queued\"\n }), \" — waiting to start\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"rendering\"\n }), \" — in progress\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"complete\"\n }), \" — ready; see \", _jsx(_components.code, {\n children: \"downloads\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"error\"\n }), \" — a failure occurred (see \", _jsx(_components.code, {\n children: \"error\"\n }), \")\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"canceled\"\n }), \" — user canceled\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"draft\"\n }), \" — not used\"]\n }), \"\\n\"]\n })]\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":"Get image details","description":"Check the progress of a image project. The `downloads` field is populated after a successful render.\n \n**Statuses**\n- `queued` — waiting to start\n- `rendering` — in progress\n- `complete` — ready; see `downloads`\n- `error` — a failure occurred (see `error`)\n- `canceled` — user canceled\n- `draft` — not used","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/image-projects/{id}","href":"/api-reference/image-projects/get-image-details","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Check the progress of a image project. The `downloads` field is populated after a successful render.\n \n**Statuses**\n- `queued` — waiting to start\n- `rendering` — in progress\n- `complete` — ready; see `downloads`\n- `error` — a failure occurred (see `error`)\n- `canceled` — user canceled\n- `draft` — not used","summary":"Get image details","tags":["Image Projects"],"parameters":["ad624d9a-4da0-49fb-a13b-d2398f63d5f7"],"operationId":"imageProjects.getDetails","responses":{"200":"c1b74425-527a-4737-9bb5-1e7b59e7b2a5","400":"a91f72da-1b42-4f77-8e58-d95bdfd8d7d6","401":"90fef612-aa02-4a7b-8860-edd4fd7d47ef","402":"73bbe35b-7c00-4434-b4fd-cd3ec6bf0eb2","404":"95ae075d-c7d4-4dde-b158-d4235b319d87","500":"bb079c57-1565-4c9d-a690-a802cde72252"},"security":["673ab71d-85e4-401e-8bd5-f9d165b5e210"],"x-codeSamples":[{"lang":"python","source":"from magic_hour import Client\nfrom os import getenv\n\nclient = Client(token=getenv(\"MAGIC_HOUR_API_KEY\"))\nres = client.v1.image_projects.get(id=\"cuid-example\")"},{"lang":"javascript","source":"import { Client } from \"magic-hour\";\n\nconst client = new Client({ token: process.env[\"MAGIC_HOUR_API_KEY\"] });\nconst res = await client.v1.imageProjects.get({ id: \"cuid-example\" });"},{"lang":"go","source":"package main\n\nimport (\n\tos \"os\"\n\n\tsdk \"github.com/magichourhq/magic-hour-go/client\"\n\timage_projects \"github.com/magichourhq/magic-hour-go/resources/v1/image_projects\"\n)\n\nfunc main() {\n\tclient := sdk.NewClient(\n\t\tsdk.WithBearerAuth(os.Getenv(\"MAGIC_HOUR_API_KEY\")),\n\t)\n\tres, err := client.V1.ImageProjects.Get(image_projects.GetRequest{\n\t\tId: \"cuid-example\",\n\t})\n}"},{"lang":"rust","source":"let client = magic_hour::Client::default()\n .with_bearer_auth(\u0026std::env::var(\"MAGIC_HOUR_API_KEY\").unwrap());\nlet res = client\n .v1()\n .image_projects()\n .get(magic_hour::resources::v1::image_projects::GetRequest {\n id: \"cuid-example\".to_string(),\n })\n .await;"},{"lang":"curl","source":"curl --request GET \\\n --url https://api.magichour.ai/v1/image-projects/id \\\n --header 'accept: application/json' \\\n --header \"authorization: Bearer $MAGIC_HOUR_API_KEY\""},{"lang":"php","source":"\u003c?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.magichour.ai/v1/image-projects/id\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"accept: application/json\",\n \"authorization: Bearer \u003ctoken>\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"java","source":"HttpResponse\u003cString> response = Unirest.get(\"https://api.magichour.ai/v1/image-projects/id\")\n .header(\"accept\", \"application/json\")\n .header(\"authorization\", \"Bearer \u003ctoken>\")\n .asString();"}],"method":"get","type":"path","servers":["bff22ee6-56d2-4175-a168-cad9a2398d0a"],"path":"/v1/image-projects/{id}","baseUrlOptions":["https://api.magichour.ai"],"title":"Get image details","codeSamples":[{"lang":"python","source":"from magic_hour import Client\nfrom os import getenv\n\nclient = Client(token=getenv(\"MAGIC_HOUR_API_KEY\"))\nres = client.v1.image_projects.get(id=\"cuid-example\")"},{"lang":"javascript","source":"import { Client } from \"magic-hour\";\n\nconst client = new Client({ token: process.env[\"MAGIC_HOUR_API_KEY\"] });\nconst res = await client.v1.imageProjects.get({ id: \"cuid-example\" });"},{"lang":"go","source":"package main\n\nimport (\n\tos \"os\"\n\n\tsdk \"github.com/magichourhq/magic-hour-go/client\"\n\timage_projects \"github.com/magichourhq/magic-hour-go/resources/v1/image_projects\"\n)\n\nfunc main() {\n\tclient := sdk.NewClient(\n\t\tsdk.WithBearerAuth(os.Getenv(\"MAGIC_HOUR_API_KEY\")),\n\t)\n\tres, err := client.V1.ImageProjects.Get(image_projects.GetRequest{\n\t\tId: \"cuid-example\",\n\t})\n}"},{"lang":"rust","source":"let client = magic_hour::Client::default()\n .with_bearer_auth(\u0026std::env::var(\"MAGIC_HOUR_API_KEY\").unwrap());\nlet res = client\n .v1()\n .image_projects()\n .get(magic_hour::resources::v1::image_projects::GetRequest {\n id: \"cuid-example\".to_string(),\n })\n .await;"},{"lang":"curl","source":"curl --request GET \\\n --url https://api.magichour.ai/v1/image-projects/id \\\n --header 'accept: application/json' \\\n --header \"authorization: Bearer $MAGIC_HOUR_API_KEY\""},{"lang":"php","source":"\u003c?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.magichour.ai/v1/image-projects/id\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"accept: application/json\",\n \"authorization: Bearer \u003ctoken>\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"java","source":"HttpResponse\u003cString> response = Unirest.get(\"https://api.magichour.ai/v1/image-projects/id\")\n .header(\"accept\", \"application/json\")\n .header(\"authorization\", \"Bearer \u003ctoken>\")\n .asString();"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"ad624d9a-4da0-49fb-a13b-d2398f63d5f7":{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"cuid-example","isRequired":true,"description":"Unique ID of the image project. This value is returned by all of the POST APIs that create an image.","uniqueKey":"","typeLabel":"string"},"description":"Unique ID of the image project. This value is returned by all of the POST APIs that create an image."}},"responses":{"c1b74425-527a-4737-9bb5-1e7b59e7b2a5":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"cuid-example","description":"Unique ID of the image. Use it with the [Get image Project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch status and downloads.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"The name of the image.","example":"Example Name","isRequired":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the image.","example":"Example Name","isRequired":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"name","typeLabel":"string | null"},"status":{"type":"string","enum":["draft","queued","rendering","complete","error","canceled"],"description":"The status of the image.\n\n- `draft` - the project was created but has not been submitted for rendering\n- `queued` - the job is waiting for an available server\n- `rendering` - the job is being processed; the `image.started` webhook event fires when rendering begins\n- `complete` - the job finished successfully; fires `image.completed`\n- `error` - the job failed during processing; fires `image.errored`\n- `canceled` - the job was manually canceled (for example from the Magic Hour web app)\n\n**Note:** `rendering`, `complete`, and `error` have matching webhook events; `canceled` does not - a canceled job emits no webhook event, so poll this endpoint to detect cancellation.","example":"complete","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"image_count":{"type":"integer","description":"Number of images generated","example":1,"isRequired":true,"uniqueKey":"image_count","typeLabel":"integer"},"type":{"type":"string","description":"The type of the image project. Possible values are FACE_EDITOR, AI_IMAGE_EDITOR, GENERATIVE_FILL, AI_SELFIE, AI_HEADSHOT, AI_INFLUENCER, AI_IMAGE, AI_MEME, CLOTHES_CHANGER, BACKGROUND_REMOVER, FACE_SWAP, IMAGE_UPSCALER, IMAGE_ENHANCER, AI_GIF, QR_CODE, PHOTO_EDITOR, PHOTO_COLORIZER, IMAGE_COLOR_GRADER, HEAD_SWAP, BODY_SWAP, STORYBOARD, IMAGE_EXPANDER","example":"AI_IMAGE","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"enabled":{"type":"boolean","description":"Whether this resource is active. If false, it is deleted.","isRequired":true,"uniqueKey":"enabled","typeLabel":"boolean"},"credits_charged":{"type":"integer","example":5,"description":"The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. \n\nIf an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.","isRequired":true,"uniqueKey":"credits_charged","typeLabel":"integer"},"downloads":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","example":"https://videos.magichour.ai/id/output.png","isRequired":true,"uniqueKey":"downloads.items.[INDEX].url","typeLabel":"string\u003curi>"},"expires_at":{"type":"string","format":"date-time","example":"2024-10-19T05:16:19.027Z","isRequired":true,"uniqueKey":"downloads.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"}},"required":["url","expires_at"],"description":"The download url and expiration date of the image project","uniqueKey":"downloads.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"downloads","typeLabel":"object[]"},"error":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","description":"Details on the reason why a failure happened.","example":"Please use an image with a detectable face","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"code":{"type":"string","example":"no_source_face","description":"An error code to indicate why a failure happened.","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"}},"required":["message","code"],"description":"In the case of an error, this object will contain the error encountered during video render","example":null,"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"message":{"type":"string","description":"Details on the reason why a failure happened.","example":"Please use an image with a detectable face"},"code":{"type":"string","example":"no_source_face","description":"An error code to indicate why a failure happened."}},"required":["message","code"],"description":"In the case of an error, this object will contain the error encountered during video render","example":null,"isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"}},"required":["id","name","status","image_count","type","created_at","enabled","credits_charged","downloads","error"],"description":"Success","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cuid-example","name":"Example Name","status":"complete","image_count":1,"type":"AI_IMAGE","created_at":"2023-11-07T05:31:56Z","enabled":true,"credits_charged":5,"downloads":[{"url":"https://videos.magichour.ai/id/output.png","expires_at":"2024-10-19T05:16:19.027Z"}],"error":null}}},"exampleType":"generated"}},"exampleType":"generated"},"a91f72da-1b42-4f77-8e58-d95bdfd8d7d6":{"description":"Invalid Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request"],"description":"Machine-readable error code.\n\n- `invalid_request`: Fix request syntax or validation errors before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"invalid_request","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"90fef612-aa02-4a7b-8860-edd4fd7d47ef":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["unauthorized"],"description":"Machine-readable error code.\n\n- `unauthorized`: Provide a valid API key before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unauthorized","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"73bbe35b-7c00-4434-b4fd-cd3ec6bf0eb2":{"description":"Payment Required","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["insufficient_credits","subscription_required","plan_upgrade_required"],"description":"Machine-readable error code.\n\n- `insufficient_credits`: Purchase credits before retrying.\n\n- `subscription_required`: Start a subscription before retrying.\n\n- `plan_upgrade_required`: Upgrade the subscription plan before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"insufficient_credits","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"95ae075d-c7d4-4dde-b158-d4235b319d87":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["not_found"],"description":"Machine-readable error code.\n\n- `not_found`: Check the route or resource identifier.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"not_found","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bb079c57-1565-4c9d-a690-a802cde72252":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["internal_server_error"],"description":"Machine-readable error code.\n\n- `internal_server_error`: Retry later or contact support if the error continues.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"internal_server_error","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"673ab71d-85e4-401e-8bd5-f9d165b5e210":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003capi_key>`, where `\u003capi_key>` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=api-reference) and click \"Create new API Key\".","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bff22ee6-56d2-4175-a168-cad9a2398d0a":{"url":"https://api.magichour.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003capi_key>`, where `\u003capi_key>` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=api-reference) and click \"Create new API Key\".","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003capi_key>`, where `\u003capi_key>` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=api-reference) and click \"Create new API Key\".","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"magichour","siteName":"Magic Hour API Docs","title":"Get image details - Magic Hour API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T04:29:41.926Z","originalFileLocation":"api-reference/image-projects/get-image-details.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=\"dark\"}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=\"Check the progress of a image project. The downloads field is populated after a successful render. Statuses - queued — waiting to start - rendering — in progress - complete — ready; see downloads - error — a failure occurred (see error) - canceled — user canceled - draft — not used\">\u003cmeta data-mint-head name=\"application-name\" content=\"Magic Hour API 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/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_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/magichour/pV2W72GIHTaiOFzk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get image details - Magic Hour API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check the progress of a image project. The downloads field is populated after a successful render. Statuses - queued — waiting to start - rendering — in progress - complete — ready; see downloads - error — a failure occurred (see error) - canceled — user canceled - draft — not used\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Magic Hour API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.magichour.ai/api-reference/image-projects/get-image-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg\">\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=\"Get image details - Magic Hour API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check the progress of a image project. The downloads field is populated after a successful render. Statuses - queued — waiting to start - rendering — in progress - complete — ready; see downloads - error — a failure occurred (see error) - canceled — user canceled - draft — not used\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg\">\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/magichour/pV2W72GIHTaiOFzk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Magic Hour API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.magichour.ai/api-reference/image-projects/get-image-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/image-projects/get-image-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.magichour.ai/#organization\",\"name\":\"Magic Hour API Docs\",\"url\":\"https://docs.magichour.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/magichour/5sgGJpuuipkw5s5v/icons/logo-light.svg?fit=max\u0026auto=format\u0026n=5sgGJpuuipkw5s5v\u0026q=85\u0026s=1f167e30baf11927bc2e0932411e455b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.magichour.ai#website\",\"name\":\"Magic Hour API Docs\",\"url\":\"https://docs.magichour.ai\",\"publisher\":{\"@id\":\"https://docs.magichour.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details#webpage\",\"url\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details\",\"name\":\"Get image details\",\"description\":\"Check the progress of a image project. The downloads field is populated after a successful render. Statuses - queued — waiting to start - rendering — in progress - complete — ready; see downloads - error — a failure occurred (see error) - canceled — user canceled - draft — not used\",\"dateModified\":\"2026-11-03T04:29:41.926Z\",\"isPartOf\":{\"@id\":\"https://docs.magichour.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Magic Hour API Docs\",\"item\":\"https://docs.magichour.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get image details\",\"item\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details#apireference\",\"headline\":\"Get image details\",\"name\":\"Get image details\",\"description\":\"Check the progress of a image project. The downloads field is populated after a successful render. Statuses - queued — waiting to start - rendering — in progress - complete — ready; see downloads - error — a failure occurred (see error) - canceled — user canceled - draft — not used\",\"url\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details\",\"mainEntityOfPage\":{\"@id\":\"https://docs.magichour.ai/api-reference/image-projects/get-image-details#webpage\"},\"image\":\"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg\",\"dateModified\":\"2026-11-03T04:29:41.926Z\",\"publisher\":{\"@id\":\"https://docs.magichour.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.magichour.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Magic Hour API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Magic Hour API Docs","nav":{"global":{"anchors":[{"anchor":"API quickstart","icon":"forward-fast","href":"/get-started/quick-start"},{"anchor":"API pricing","icon":"credit-card","href":"/billing/overview"},{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/JX5rgsZaJp"},{"anchor":"Status","icon":"wave-pulse","href":"https://status.magichour.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"Models and Credit Costs","sidebarTitle":"Models","href":"/api-reference/models"},{"title":"Historical API Processing Times","sidebarTitle":"Processing Times","href":"/api-reference/processing-times"},{"group":"Account","pages":[{"title":"Get account details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account","href":"/api-reference/account/get-account-details"}]},{"group":"Files","pages":[{"title":"List saved items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/saved-items","href":"/api-reference/files/list-saved-items"},{"title":"Generate asset upload urls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/files/upload-urls","href":"/api-reference/files/generate-asset-upload-urls"},{"title":"Get face detection details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/face-detection/{id}","href":"/api-reference/files/get-face-detection-details"},{"title":"Face Detection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/face-detection","href":"/api-reference/files/face-detection"}]},{"group":"Video Projects","pages":[{"title":"Get video details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/video-projects/{id}","href":"/api-reference/video-projects/get-video-details"},{"title":"Delete video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/video-projects/{id}","href":"/api-reference/video-projects/delete-video"},{"title":"AI Talking Photo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-talking-photo","href":"/api-reference/video-projects/ai-talking-photo"},{"title":"AI UGC Ad Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-ugc-ad","href":"/api-reference/video-projects/ai-ugc-ad-generator"},{"title":"AI Video Editor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-video-editor","href":"/api-reference/video-projects/ai-video-editor"},{"title":"AI Video Translator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-video-translator","href":"/api-reference/video-projects/ai-video-translator"},{"title":"AI Video Upscaler","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-video-upscaler","href":"/api-reference/video-projects/ai-video-upscaler"},{"title":"Animation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/animation","href":"/api-reference/video-projects/animation"},{"title":"Audio-to-Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audio-to-video","href":"/api-reference/video-projects/audio-to-video"},{"title":"Auto Subtitle Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auto-subtitle-generator","href":"/api-reference/video-projects/auto-subtitle-generator"},{"title":"Character Replace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/character-replace","href":"/api-reference/video-projects/character-replace"},{"title":"Face Swap Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/face-swap","href":"/api-reference/video-projects/face-swap-video"},{"title":"Image-to-Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/image-to-video","href":"/api-reference/video-projects/image-to-video"},{"title":"Lip Sync","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lip-sync","href":"/api-reference/video-projects/lip-sync"},{"title":"Text-to-Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/text-to-video","href":"/api-reference/video-projects/text-to-video"},{"title":"Video-to-Video","description":"**What this API does**\n\nCreate the same Video To Video you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow.\n \n**Good for**\n- Automation and batch processing \n- Adding video to video into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) Upload your inputs (video, image, or audio) with [Generate Upload URLs](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls) and copy the `file_path`. \n2) Send a request to create a video to video job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/video-to-video).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/video-to-video","href":"/api-reference/video-projects/video-to-video"}]},{"group":"Image Projects","pages":[{"title":"Get image details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/image-projects/{id}","href":"/api-reference/image-projects/get-image-details"},{"title":"Delete image","description":"Permanently delete the rendered image(s). This action is not reversible, please be sure before deleting.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/image-projects/{id}","href":"/api-reference/image-projects/delete-image"},{"title":"AI Clothes Changer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-clothes-changer","href":"/api-reference/image-projects/ai-clothes-changer"},{"title":"AI Face Editor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-face-editor","href":"/api-reference/image-projects/ai-face-editor"},{"title":"AI GIF Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-gif-generator","href":"/api-reference/image-projects/ai-gif-generator"},{"title":"AI Image Editor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-image-editor","href":"/api-reference/image-projects/ai-image-editor"},{"title":"AI Headshot Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-headshot-generator","href":"/api-reference/image-projects/ai-headshot-generator"},{"title":"AI Image Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-image-generator","href":"/api-reference/image-projects/ai-image-generator"},{"title":"AI Image Upscaler","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-image-upscaler","href":"/api-reference/image-projects/ai-image-upscaler"},{"title":"AI Meme Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-meme-generator","href":"/api-reference/image-projects/ai-meme-generator"},{"title":"AI QR Code Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-qr-code-generator","href":"/api-reference/image-projects/ai-qr-code-generator"},{"title":"Body Swap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/body-swap","href":"/api-reference/image-projects/body-swap"},{"title":"Face Swap Photo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/face-swap-photo","href":"/api-reference/image-projects/face-swap-photo"},{"title":"Head Swap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/head-swap","href":"/api-reference/image-projects/head-swap"},{"title":"Image Background Remover","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/image-background-remover","href":"/api-reference/image-projects/image-background-remover"},{"title":"Photo Colorizer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/photo-colorizer","href":"/api-reference/image-projects/photo-colorizer"}]},{"group":"Audio Projects","pages":[{"title":"Get audio details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audio-projects/{id}","href":"/api-reference/audio-projects/get-audio-details"},{"title":"Delete audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/audio-projects/{id}","href":"/api-reference/audio-projects/delete-audio"},{"title":"AI Music Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-music-generator","href":"/api-reference/audio-projects/ai-music-generator"},{"title":"AI Voice Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-voice-generator","href":"/api-reference/audio-projects/ai-voice-generator"},{"title":"AI Voice Cloner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-voice-cloner","href":"/api-reference/audio-projects/ai-voice-cloner"}]}],"groups":[{"group":"Account","pages":[{"title":"Get account details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account","href":"/api-reference/account/get-account-details"}]},{"group":"Files","pages":[{"title":"List saved items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/saved-items","href":"/api-reference/files/list-saved-items"},{"title":"Generate asset upload urls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/files/upload-urls","href":"/api-reference/files/generate-asset-upload-urls"},{"title":"Get face detection details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/face-detection/{id}","href":"/api-reference/files/get-face-detection-details"},{"title":"Face Detection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/face-detection","href":"/api-reference/files/face-detection"}]},{"group":"Video Projects","pages":[{"title":"Get video details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/video-projects/{id}","href":"/api-reference/video-projects/get-video-details"},{"title":"Delete video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/video-projects/{id}","href":"/api-reference/video-projects/delete-video"},{"title":"AI Talking Photo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-talking-photo","href":"/api-reference/video-projects/ai-talking-photo"},{"title":"AI UGC Ad Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-ugc-ad","href":"/api-reference/video-projects/ai-ugc-ad-generator"},{"title":"AI Video Editor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-video-editor","href":"/api-reference/video-projects/ai-video-editor"},{"title":"AI Video Translator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-video-translator","href":"/api-reference/video-projects/ai-video-translator"},{"title":"AI Video Upscaler","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-video-upscaler","href":"/api-reference/video-projects/ai-video-upscaler"},{"title":"Animation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/animation","href":"/api-reference/video-projects/animation"},{"title":"Audio-to-Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audio-to-video","href":"/api-reference/video-projects/audio-to-video"},{"title":"Auto Subtitle Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auto-subtitle-generator","href":"/api-reference/video-projects/auto-subtitle-generator"},{"title":"Character Replace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/character-replace","href":"/api-reference/video-projects/character-replace"},{"title":"Face Swap Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/face-swap","href":"/api-reference/video-projects/face-swap-video"},{"title":"Image-to-Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/image-to-video","href":"/api-reference/video-projects/image-to-video"},{"title":"Lip Sync","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lip-sync","href":"/api-reference/video-projects/lip-sync"},{"title":"Text-to-Video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/text-to-video","href":"/api-reference/video-projects/text-to-video"},{"title":"Video-to-Video","description":"**What this API does**\n\nCreate the same Video To Video you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow.\n \n**Good for**\n- Automation and batch processing \n- Adding video to video into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) Upload your inputs (video, image, or audio) with [Generate Upload URLs](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls) and copy the `file_path`. \n2) Send a request to create a video to video job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/video-to-video).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/video-to-video","href":"/api-reference/video-projects/video-to-video"}]},{"group":"Image Projects","pages":[{"title":"Get image details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/image-projects/{id}","href":"/api-reference/image-projects/get-image-details"},{"title":"Delete image","description":"Permanently delete the rendered image(s). This action is not reversible, please be sure before deleting.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/image-projects/{id}","href":"/api-reference/image-projects/delete-image"},{"title":"AI Clothes Changer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-clothes-changer","href":"/api-reference/image-projects/ai-clothes-changer"},{"title":"AI Face Editor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-face-editor","href":"/api-reference/image-projects/ai-face-editor"},{"title":"AI GIF Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-gif-generator","href":"/api-reference/image-projects/ai-gif-generator"},{"title":"AI Image Editor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-image-editor","href":"/api-reference/image-projects/ai-image-editor"},{"title":"AI Headshot Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-headshot-generator","href":"/api-reference/image-projects/ai-headshot-generator"},{"title":"AI Image Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-image-generator","href":"/api-reference/image-projects/ai-image-generator"},{"title":"AI Image Upscaler","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-image-upscaler","href":"/api-reference/image-projects/ai-image-upscaler"},{"title":"AI Meme Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-meme-generator","href":"/api-reference/image-projects/ai-meme-generator"},{"title":"AI QR Code Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-qr-code-generator","href":"/api-reference/image-projects/ai-qr-code-generator"},{"title":"Body Swap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/body-swap","href":"/api-reference/image-projects/body-swap"},{"title":"Face Swap Photo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/face-swap-photo","href":"/api-reference/image-projects/face-swap-photo"},{"title":"Head Swap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/head-swap","href":"/api-reference/image-projects/head-swap"},{"title":"Image Background Remover","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/image-background-remover","href":"/api-reference/image-projects/image-background-remover"},{"title":"Photo Colorizer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/photo-colorizer","href":"/api-reference/image-projects/photo-colorizer"}]},{"group":"Audio Projects","pages":[{"title":"Get audio details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audio-projects/{id}","href":"/api-reference/audio-projects/get-audio-details"},{"title":"Delete audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/audio-projects/{id}","href":"/api-reference/audio-projects/delete-audio"},{"title":"AI Music Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-music-generator","href":"/api-reference/audio-projects/ai-music-generator"},{"title":"AI Voice Cloner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-voice-cloner","href":"/api-reference/audio-projects/ai-voice-cloner"},{"title":"AI Voice Generator","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/ai-voice-generator","href":"/api-reference/audio-projects/ai-voice-generator"}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get image details - Magic Hour API Docs","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}