{"componentChunkName":"component---src-templates-docs-js","path":"/integrations/api","result":{"data":{"site":{"siteMetadata":{"title":"Documentation | DesignerBox","docsLocation":""}},"mdx":{"fields":{"id":"402392f7-6bc7-5ffd-b306-4931696af83a","title":"API","slug":"/integrations/api","locale":"en-GB"},"body":"var _excluded = [\"components\"];\nfunction _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }\nfunction _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }\nfunction _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\nvar _frontmatter = {\n  \"title\": \"API\",\n  \"metaTitle\": \"DesignerBox API | Image & Video Generation\",\n  \"metaDescription\": \"Use the DesignerBox REST API under /api/v1 to generate AI images and video, manage assets, and run workflows programmatically.\",\n  \"order\": 1\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n    props = _objectWithoutProperties(_ref, _excluded);\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"h1\", null, \"API\"), mdx(\"p\", null, \"DesignerBox exposes a REST API so you can generate media and manage assets programmatically, powering the same capabilities you use in the app.\"), mdx(\"p\", null, mdx(\"span\", {\n    parentName: \"p\",\n    \"className\": \"gatsby-resp-image-wrapper\",\n    \"style\": {\n      \"position\": \"relative\",\n      \"display\": \"block\",\n      \"marginLeft\": \"auto\",\n      \"marginRight\": \"auto\",\n      \"maxWidth\": \"800px\"\n    }\n  }, \"\\n      \", mdx(\"a\", {\n    parentName: \"span\",\n    \"className\": \"gatsby-resp-image-link\",\n    \"href\": \"/docs/static/22f2eb7e101ec8093af2a604793b65d2/356e8/home.jpg\",\n    \"style\": {\n      \"display\": \"block\"\n    },\n    \"target\": \"_blank\",\n    \"rel\": \"noopener\"\n  }, \"\\n    \", mdx(\"span\", {\n    parentName: \"a\",\n    \"className\": \"gatsby-resp-image-background-image\",\n    \"style\": {\n      \"paddingBottom\": \"56.49999999999999%\",\n      \"position\": \"relative\",\n      \"bottom\": \"0\",\n      \"left\": \"0\",\n      \"backgroundImage\": \"url('data:image/jpeg;base64,/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wgARCAALABQDASIAAhEBAxEB/8QAFgABAQEAAAAAAAAAAAAAAAAAAAEF/8QAFAEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEAMQAAAB3bKAf//EABQQAQAAAAAAAAAAAAAAAAAAACD/2gAIAQEAAQUCX//EABQRAQAAAAAAAAAAAAAAAAAAABD/2gAIAQMBAT8BP//EABQRAQAAAAAAAAAAAAAAAAAAABD/2gAIAQIBAT8BP//EABQQAQAAAAAAAAAAAAAAAAAAACD/2gAIAQEABj8CX//EABkQAAIDAQAAAAAAAAAAAAAAAAEQABExIf/aAAgBAQABPyGhYXJuv//aAAwDAQACAAMAAAAQ0+//xAAUEQEAAAAAAAAAAAAAAAAAAAAQ/9oACAEDAQE/ED//xAAUEQEAAAAAAAAAAAAAAAAAAAAQ/9oACAECAQE/ED//xAAbEAEAAgIDAAAAAAAAAAAAAAABESEAURAxQf/aAAgBAQABPxBsKUisaSOsdowJeod8/wD/2Q==')\",\n      \"backgroundSize\": \"cover\",\n      \"display\": \"block\"\n    }\n  }), \"\\n  \", mdx(\"img\", {\n    parentName: \"a\",\n    \"className\": \"gatsby-resp-image-image\",\n    \"alt\": \"The DesignerBox app, whose image, video, and asset features are also available over the API\",\n    \"title\": \"The DesignerBox app, whose image, video, and asset features are also available over the API\",\n    \"src\": \"/docs/static/22f2eb7e101ec8093af2a604793b65d2/4b190/home.jpg\",\n    \"srcSet\": [\"/docs/static/22f2eb7e101ec8093af2a604793b65d2/e07e9/home.jpg 200w\", \"/docs/static/22f2eb7e101ec8093af2a604793b65d2/066f9/home.jpg 400w\", \"/docs/static/22f2eb7e101ec8093af2a604793b65d2/4b190/home.jpg 800w\", \"/docs/static/22f2eb7e101ec8093af2a604793b65d2/e5166/home.jpg 1200w\", \"/docs/static/22f2eb7e101ec8093af2a604793b65d2/356e8/home.jpg 1512w\"],\n    \"sizes\": \"(max-width: 800px) 100vw, 800px\",\n    \"style\": {\n      \"width\": \"100%\",\n      \"height\": \"100%\",\n      \"margin\": \"0\",\n      \"verticalAlign\": \"middle\",\n      \"position\": \"absolute\",\n      \"top\": \"0\",\n      \"left\": \"0\"\n    },\n    \"loading\": \"lazy\"\n  }), \"\\n  \"), \"\\n    \")), mdx(\"h2\", null, \"Base path\"), mdx(\"p\", null, \"All endpoints live under the versioned prefix \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"/api/v1/\"), \". Requests and responses are JSON.\"), mdx(\"h2\", null, \"What you can do\"), mdx(\"p\", null, \"The API mirrors the product's core areas, including:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"ai\"), \" - image and video generation.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"assets\"), \" - your files and generated media.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"video-tasks\"), \" - track video generation jobs.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"templates\"), \" and \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"pipelines\"), \" - run techniques and workflows.\")), mdx(\"h2\", null, \"Credits\"), mdx(\"p\", null, \"API generations consume credits from your plan, the same pool the app uses. A generation deducts credits when it runs, so monitor your balance in the app. See \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"/docs/knowledge-base/plans-credits-and-limits\"\n  }, \"Plans, Credits, and Limits\"), \".\"), mdx(\"p\", null, \"For programmatic access tied to your account, manage access from your account settings in the app.\"), mdx(\"h2\", null, \"Related\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"/docs/features/workflows-and-canvas\"\n  }, \"Workflows and the Canvas\"), \" - the pipelines the API can run.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"/docs/integrations/white-label\"\n  }, \"White-Label\"), \" - serve generation under your own brand.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"/docs/knowledge-base/plans-credits-and-limits\"\n  }, \"Plans, Credits, and Limits\"), \" - how API generations consume credits.\")));\n}\n;\nMDXContent.isMDXComponent = true;","rawBody":"---\ntitle: \"API\"\nmetaTitle: \"DesignerBox API | Image & Video Generation\"\nmetaDescription: \"Use the DesignerBox REST API under /api/v1 to generate AI images and video, manage assets, and run workflows programmatically.\"\norder: 1\n---\n\n# API\n\nDesignerBox exposes a REST API so you can generate media and manage assets programmatically, powering the same capabilities you use in the app.\n\n![The DesignerBox app, whose image, video, and asset features are also available over the API](../images/docs/home.jpg)\n\n## Base path\n\nAll endpoints live under the versioned prefix `/api/v1/`. Requests and responses are JSON.\n\n## What you can do\n\nThe API mirrors the product's core areas, including:\n\n- `ai` - image and video generation.\n- `assets` - your files and generated media.\n- `video-tasks` - track video generation jobs.\n- `templates` and `pipelines` - run techniques and workflows.\n\n## Credits\n\nAPI generations consume credits from your plan, the same pool the app uses. A generation deducts credits when it runs, so monitor your balance in the app. See [Plans, Credits, and Limits](/knowledge-base/plans-credits-and-limits).\n\nFor programmatic access tied to your account, manage access from your account settings in the app.\n\n## Related\n\n- [Workflows and the Canvas](/features/workflows-and-canvas) - the pipelines the API can run.\n- [White-Label](/integrations/white-label) - serve generation under your own brand.\n- [Plans, Credits, and Limits](/knowledge-base/plans-credits-and-limits) - how API generations consume credits.\n","tableOfContents":{"items":[{"url":"#api","title":"API","items":[{"url":"#base-path","title":"Base path"},{"url":"#what-you-can-do","title":"What you can do"},{"url":"#credits","title":"Credits"},{"url":"#related","title":"Related"}]}]},"parent":{"__typename":"File","relativePath":"en/integrations/api.md"},"frontmatter":{"metaTitle":"DesignerBox API | Image & Video Generation","metaDescription":"Use the DesignerBox REST API under /api/v1 to generate AI images and video, manage assets, and run workflows programmatically.","order":1}},"allMdx":{"edges":[{"node":{"fields":{"slug":"/features","title":"Features"}}},{"node":{"fields":{"slug":"/guides","title":"Guides"}}},{"node":{"fields":{"slug":"/integrations","title":"Integrations"}}},{"node":{"fields":{"slug":"/pricing-faqs","title":"Pricing FAQs"}}},{"node":{"fields":{"slug":"/knowledge-base","title":"Knowledge Base"}}},{"node":{"fields":{"slug":"/features/avatars-and-models","title":"AI Character"}}},{"node":{"fields":{"slug":"/features/brand-profile","title":"Brand Profile and Library"}}},{"node":{"fields":{"slug":"/features/relighting-and-angles","title":"Relighting and Angles"}}},{"node":{"fields":{"slug":"/features/upscaling","title":"Upscaling"}}},{"node":{"fields":{"slug":"/features/image-generation","title":"AI Image"}}},{"node":{"fields":{"slug":"/features/virtual-try-on","title":"Virtual Try-On"}}},{"node":{"fields":{"slug":"/features/video","title":"AI Video"}}},{"node":{"fields":{"slug":"/guides/building-workflows-on-the-canvas","title":"Building Workflows on the Canvas"}}},{"node":{"fields":{"slug":"/guides/create-your-first-image","title":"Create Your First Image"}}},{"node":{"fields":{"slug":"/features/techniques-and-templates","title":"Techniques and Templates"}}},{"node":{"fields":{"slug":"/guides/teams-and-brand-profiles","title":"Teams and Brand Profiles"}}},{"node":{"fields":{"slug":"/features/community","title":"Community"}}},{"node":{"fields":{"slug":"/guides/using-techniques-and-templates","title":"Using Techniques and Templates"}}},{"node":{"fields":{"slug":"/features/workflows-and-canvas","title":"Workflows and the Canvas"}}},{"node":{"fields":{"slug":"/integrations/api","title":"API"}}},{"node":{"fields":{"slug":"/guides/creating-videos","title":"Creating Videos"}}},{"node":{"fields":{"slug":"/integrations/white-label","title":"White-Label"}}},{"node":{"fields":{"slug":"/knowledge-base/how-to-update-card-details","title":"How to Update Card Details"}}},{"node":{"fields":{"slug":"/knowledge-base/plans-credits-and-limits","title":"Plans, Credits, and Limits"}}},{"node":{"fields":{"slug":"/knowledge-base/understanding-declined-card-payments","title":"Understanding Declined Card Payments"}}},{"node":{"fields":{"slug":"/features/workflows-and-canvas/node-types","title":"Node Types"}}},{"node":{"fields":{"slug":"/features/image-generation/editing-modes","title":"Editing Modes"}}},{"node":{"fields":{"slug":"/","title":"DesignerBox Documentation"}}}]}},"pageContext":{"id":"402392f7-6bc7-5ffd-b306-4931696af83a","locale":"en-GB"}},"staticQueryHashes":["361965504","361965504","417421954","417421954","445494767","445494767"]}