{"componentChunkName":"component---src-templates-docs-js","path":"/pt-pt/integrations/api","result":{"data":{"site":{"siteMetadata":{"title":"Documentation | DesignerBox","docsLocation":""}},"mdx":{"fields":{"id":"11bcf61a-6283-5507-9ece-a9ac6834b614","title":"API","slug":"/pt-pt/integrations/api","locale":"pt-PT"},"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\": \"API DesignerBox | Geracao de Imagens e Videos\",\n  \"metaDescription\": \"Usa a API REST do DesignerBox em /api/v1 para gerar imagens e videos com AI, gerir recursos e executar fluxos de trabalho.\",\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, \"O DesignerBox expoe uma API REST para que possas gerar conteudo media e gerir recursos de forma programatica, disponibilizando as mesmas capacidades que utilizas na aplicacao.\"), 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\": \"A aplicacao DesignerBox, cujas funcionalidades de imagem, video e recursos estao tambem disponiveis atraves da API\",\n    \"title\": \"A aplicacao DesignerBox, cujas funcionalidades de imagem, video e recursos estao tambem disponiveis atraves da 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, \"Caminho base\"), mdx(\"p\", null, \"Todos os endpoints estao sob o prefixo versionado \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"/api/v1/\"), \". Os pedidos e respostas sao em JSON.\"), mdx(\"h2\", null, \"O que podes fazer\"), mdx(\"p\", null, \"A API espelha as areas principais do produto, incluindo:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"ai\"), \" - geracao de imagens e videos.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"assets\"), \" - os teus ficheiros e conteudo media gerado.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"video-tasks\"), \" - acompanha os trabalhos de geracao de video.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"templates\"), \" e \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"pipelines\"), \" - executa tecnicas e fluxos de trabalho.\")), mdx(\"h2\", null, \"Creditos\"), mdx(\"p\", null, \"As geracoes via API consomem creditos do teu plano, o mesmo conjunto que a aplicacao utiliza. Uma geracao deduz creditos quando e executada, por isso monitoriza o teu saldo na aplicacao. Consulta \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"/docs/pt-pt/knowledge-base/plans-credits-and-limits\"\n  }, \"Planos, Creditos e Limites\"), \".\"), mdx(\"p\", null, \"Para acesso programatico ligado a tua conta, gere o acesso nas definicoes da tua conta na aplicacao.\"), mdx(\"h2\", null, \"Relacionados\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"/docs/pt-pt/features/workflows-and-canvas\"\n  }, \"Fluxos de Trabalho e a Tela\"), \" - os pipelines que a API pode executar.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"/docs/pt-pt/integrations/white-label\"\n  }, \"Marca Branca\"), \" - serve geracoes sob a tua propria marca.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"/docs/pt-pt/knowledge-base/plans-credits-and-limits\"\n  }, \"Planos, Creditos e Limites\"), \" - como as geracoes via API consomem creditos.\")));\n}\n;\nMDXContent.isMDXComponent = true;","rawBody":"---\ntitle: \"API\"\nmetaTitle: \"API DesignerBox | Geracao de Imagens e Videos\"\nmetaDescription: \"Usa a API REST do DesignerBox em /api/v1 para gerar imagens e videos com AI, gerir recursos e executar fluxos de trabalho.\"\norder: 1\n---\n\n# API\n\nO DesignerBox expoe uma API REST para que possas gerar conteudo media e gerir recursos de forma programatica, disponibilizando as mesmas capacidades que utilizas na aplicacao.\n\n![A aplicacao DesignerBox, cujas funcionalidades de imagem, video e recursos estao tambem disponiveis atraves da API](../images/docs/home.jpg)\n\n## Caminho base\n\nTodos os endpoints estao sob o prefixo versionado `/api/v1/`. Os pedidos e respostas sao em JSON.\n\n## O que podes fazer\n\nA API espelha as areas principais do produto, incluindo:\n\n- `ai` - geracao de imagens e videos.\n- `assets` - os teus ficheiros e conteudo media gerado.\n- `video-tasks` - acompanha os trabalhos de geracao de video.\n- `templates` e `pipelines` - executa tecnicas e fluxos de trabalho.\n\n## Creditos\n\nAs geracoes via API consomem creditos do teu plano, o mesmo conjunto que a aplicacao utiliza. Uma geracao deduz creditos quando e executada, por isso monitoriza o teu saldo na aplicacao. Consulta [Planos, Creditos e Limites](/pt-pt/knowledge-base/plans-credits-and-limits).\n\nPara acesso programatico ligado a tua conta, gere o acesso nas definicoes da tua conta na aplicacao.\n\n## Relacionados\n\n- [Fluxos de Trabalho e a Tela](/pt-pt/features/workflows-and-canvas) - os pipelines que a API pode executar.\n- [Marca Branca](/pt-pt/integrations/white-label) - serve geracoes sob a tua propria marca.\n- [Planos, Creditos e Limites](/pt-pt/knowledge-base/plans-credits-and-limits) - como as geracoes via API consomem creditos.\n","tableOfContents":{"items":[{"url":"#api","title":"API","items":[{"url":"#caminho-base","title":"Caminho base"},{"url":"#o-que-podes-fazer","title":"O que podes fazer"},{"url":"#creditos","title":"Creditos"},{"url":"#relacionados","title":"Relacionados"}]}]},"parent":{"__typename":"File","relativePath":"pt-pt/integrations/api.md"},"frontmatter":{"metaTitle":"API DesignerBox | Geracao de Imagens e Videos","metaDescription":"Usa a API REST do DesignerBox em /api/v1 para gerar imagens e videos com AI, gerir recursos e executar fluxos de trabalho.","order":1}},"allMdx":{"edges":[{"node":{"fields":{"slug":"/pt-pt/features","title":"Funcionalidades"}}},{"node":{"fields":{"slug":"/pt-pt/guides","title":"Guias"}}},{"node":{"fields":{"slug":"/pt-pt/knowledge-base","title":"Base de Conhecimento"}}},{"node":{"fields":{"slug":"/pt-pt/pricing-faqs","title":"FAQs de Precos"}}},{"node":{"fields":{"slug":"/pt-pt/integrations","title":"Integracoes"}}},{"node":{"fields":{"slug":"/pt-pt/features/relighting-and-angles","title":"Iluminacao e Angulos"}}},{"node":{"fields":{"slug":"/pt-pt/features/community","title":"Comunidade"}}},{"node":{"fields":{"slug":"/pt-pt/features/brand-profile","title":"Perfil de Marca e Biblioteca"}}},{"node":{"fields":{"slug":"/pt-pt/features/avatars-and-models","title":"AI Character"}}},{"node":{"fields":{"slug":"/pt-pt/features/techniques-and-templates","title":"Tecnicas e Modelos"}}},{"node":{"fields":{"slug":"/pt-pt/features/upscaling","title":"Ampliacao"}}},{"node":{"fields":{"slug":"/pt-pt/features/workflows-and-canvas","title":"Fluxos de Trabalho e a Tela"}}},{"node":{"fields":{"slug":"/pt-pt/features/virtual-try-on","title":"Virtual Try-On"}}},{"node":{"fields":{"slug":"/pt-pt/features/video","title":"AI Video"}}},{"node":{"fields":{"slug":"/pt-pt/integrations/api","title":"API"}}},{"node":{"fields":{"slug":"/pt-pt/integrations/white-label","title":"Marca Branca"}}},{"node":{"fields":{"slug":"/pt-pt/guides/building-workflows-on-the-canvas","title":"Criar Fluxos de Trabalho na Tela"}}},{"node":{"fields":{"slug":"/pt-pt/guides/create-your-first-image","title":"Cria a Tua Primeira Imagem"}}},{"node":{"fields":{"slug":"/pt-pt/guides/using-techniques-and-templates","title":"Utilizar Tecnicas e Modelos"}}},{"node":{"fields":{"slug":"/pt-pt/knowledge-base/understanding-declined-card-payments","title":"Compreender Pagamentos Recusados"}}},{"node":{"fields":{"slug":"/pt-pt/features/image-generation","title":"AI Image"}}},{"node":{"fields":{"slug":"/pt-pt/knowledge-base/how-to-update-card-details","title":"Como Atualizar os Dados do Cartao"}}},{"node":{"fields":{"slug":"/pt-pt/guides/creating-videos","title":"Criar Videos"}}},{"node":{"fields":{"slug":"/pt-pt/knowledge-base/plans-credits-and-limits","title":"Planos, Creditos e Limites"}}},{"node":{"fields":{"slug":"/pt-pt/guides/teams-and-brand-profiles","title":"Equipas e Perfis de Marca"}}},{"node":{"fields":{"slug":"/pt-pt","title":"Documentacao DesignerBox"}}},{"node":{"fields":{"slug":"/pt-pt/features/workflows-and-canvas/node-types","title":"Tipos de Nos"}}},{"node":{"fields":{"slug":"/pt-pt/features/image-generation/editing-modes","title":"Modos de Edicao"}}}]}},"pageContext":{"id":"11bcf61a-6283-5507-9ece-a9ac6834b614","locale":"pt-PT"}},"staticQueryHashes":["361965504","361965504","417421954","417421954","445494767","445494767"]}