# Foveate Docs — full text > Complete text of the official Foveate documentation. Foveate is interactive presentation and proposal software for architecture, engineering, construction (AEC), and design firms. Index: https://docs.foveate.com/llms.txt · Product site: https://foveate.com/ --- # Getting started Source: https://docs.foveate.com/docs/getting-started Section: Getting started > A quick tour of Foveate — what it does and how the pieces fit together. Foveate is a workspace for AEC, creative, and pursuit teams to **draft, build, and share** client-facing work — projects (section-based data rooms), decks, interactive 3D previs, walkthroughs, and intake forms — from a single place. ## The home composer The home screen is built around one **composer**: a single prompt where you can ask a question, draft something, or kick off a build without choosing a tool first. Type what you want ("create a kickoff deck for the Aria Hotel project", "summarize the responses to my intake form", "what's on track this week") and Foveate routes it to the right place. You can attach files, scope the prompt to a specific project, and pick a product mode from the composer's inline pills. ## The core surfaces - **[Projects](https://docs.foveate.com/docs/projects)** — the section builder and virtual data room for a client engagement. Everything you make (decks, previs, walkthroughs, forms, files) can attach to a project. - **[Decks](https://docs.foveate.com/docs/decks)** — build and edit slide-based decks. - **[Forms](https://docs.foveate.com/docs/forms)** — build intake and feedback forms and read the responses. - **[Previs](https://docs.foveate.com/docs/previs)** — interactive 3D scenes. - **[Walkthroughs](https://docs.foveate.com/docs/walkthroughs)** — navigable 3D models and scans. - **[AI Chat](https://docs.foveate.com/docs/ai-chat)** — the AI composer that turns a prompt into a plan and builds it. - **[Insights](https://docs.foveate.com/docs/insights)** — analytics on how your shared work is performing. - **[Sharing & feedback](https://docs.foveate.com/docs/sharing)** — publish a link, collect feedback, and track engagement. - **[Credits & billing](https://docs.foveate.com/docs/credits-billing)** — how AI credits and your plan work. - **[Account & settings](https://docs.foveate.com/docs/account-settings)** — profile, team, and appearance. ## Light & dark mode Foveate supports both light and dark mode. Toggle it from the theme control; your choice is remembered on your device. ## Getting help Stuck or found a bug? Use the **Help / Feedback** button in the header to send a report straight to the team, or [contact the Foveate team](https://foveate.com/contact/). ## Frequently asked questions ### What is Foveate? Foveate is interactive presentation and proposal software for architecture, engineering, construction (AEC), and design firms. Instead of emailing a static PDF or slide deck, a firm builds its pitch in Foveate — a project data room, decks, 3D walkthroughs, previs, and intake forms — and shares it as one browser link that reports which stakeholders engaged. The [platform overview](https://foveate.com/overview/) covers every part of it. ### Who is Foveate for? Foveate is built for architects and architecture firms, interior designers, experiential designers, creative agencies, design-build firms, and the marketing, business development, and pursuit teams that win work for them. ### Do clients need an account or special software to view work shared from Foveate? No. Clients open work shared from Foveate as a web link in their browser, with no install, plugin, or account required. A share link can optionally ask for the viewer's name and email first — see [Sharing & feedback](https://docs.foveate.com/docs/sharing). ### Is Foveate a rendering engine? No. Foveate is not a rendering engine: firms create renderings and flythrough videos in tools like Enscape, Twinmotion, D5 Render, or Lumion, then present, share, and track that work in Foveate alongside navigable 3D models. ### How is an interactive proposal different from a PDF proposal? An interactive proposal in Foveate is a live web page rather than a file: it can hold 3D walkthroughs, video, and every supporting document in one place, it can be updated after it's sent, and it shows who opened it and what they spent time on. foveate.com's guide to [interactive proposals](https://foveate.com/interactive-proposals/) explains the difference in depth. ## Related on foveate.com - [Platform overview](https://foveate.com/overview/): The whole platform: presentations, 3D, share links, and engagement tracking. - [Architecture presentation software](https://foveate.com/architecture-presentation-software/): A complete guide to presenting design work as a link, not a file. - [Interactive proposals](https://foveate.com/interactive-proposals/): What interactive proposals are and how they replace the PDF. - [Pricing](https://foveate.com/pricing/): Plans, monthly AI credits, and team seats. - [How Architecture Firms Win More Proposals: The Complete Guide](https://foveate.com/blog/how-architecture-firms-win-more-proposals/) - [Interactive Architecture Presentations vs. PDF Proposals](https://foveate.com/blog/interactive-presentations-vs-pdf-proposals/) - [Business Development for Architecture Firms](https://foveate.com/blog/business-development-architecture-firms/) --- # Projects Source: https://docs.foveate.com/docs/projects Section: Features > The section builder and virtual data room for a client engagement — attach decks, previs, walkthroughs, forms, and files in one place. A project is the container for a single client engagement — and Foveate's **section builder**. It works as a virtual data room: a scrolling, navigable page built from sections (overview, scope, pricing, deliverables, timeline, and more) that also holds everything you make for that client — decks, previs, walkthroughs, intake forms, and reference files — so the whole pursuit lives in one place instead of scattered across separate tools. ## Creating a project Create a project from the projects list, or let the [AI Chat](https://docs.foveate.com/docs/ai-chat) composer create one for you when you describe the work you want to build. Give it a name and, optionally, a client so it's easy to find later. ## Building sections A project is assembled from sections. Add, reorder, and remove sections to build out the data room — scope, deliverables, pricing, ROI, timeline, custom content, and media. Text uses a **double-click-to-edit** model: it stays plain, selectable text until you double-click a field to edit it, which also means viewers can highlight any passage to attach feedback — see [Sharing & feedback](https://docs.foveate.com/docs/sharing). ## Attaching artifacts Anything you build in Foveate can attach to a project: - **[Decks](https://docs.foveate.com/docs/decks)** — slide-based presentations. - **[Previs](https://docs.foveate.com/docs/previs)** — interactive 3D scenes. - **[Walkthroughs](https://docs.foveate.com/docs/walkthroughs)** — navigable 3D models and scans. - **[Forms](https://docs.foveate.com/docs/forms)** — intake and feedback forms. - **Files** — reference documents, images, and other uploads. You can attach an existing item to a project, or create a new one directly from the project. ## The project page The project page shows an artifacts grid of everything attached — each deck, previs, walkthrough, form, and file as a card you can open, share, or manage. This gives you a single view of the full engagement at a glance. ## Status Each project carries a status so you can track health across your pursuits: - **On track** - **At risk** - **Off track** Set the status as work progresses. Statuses roll up into your pipeline view — see [Insights](https://docs.foveate.com/docs/insights). ## Clients and team access Assign a project to a client to organize your work by relationship. Team members with access to the project can view and edit the artifacts inside it, so collaborators stay in sync on the same engagement. For sharing work with clients and external viewers, see [Sharing & feedback](https://docs.foveate.com/docs/sharing). ## Frequently asked questions ### What is a virtual data room for an architecture proposal? A virtual data room for an architecture proposal is a single, shareable place that holds everything a client needs to evaluate a firm: the narrative, scope, fee, deliverables, and timeline, plus the decks, 3D walkthroughs, previs, forms, and files behind them. In Foveate, a project is that data room; foveate.com describes it as [Project Rooms](https://foveate.com/project-rooms/). ### How is a Foveate project different from a PDF proposal? A Foveate project is a navigable web page built from sections instead of a fixed document: it can embed interactive 3D and video, collects feedback on any highlighted passage, and reports who opened it through [Insights](https://docs.foveate.com/docs/insights). A PDF proposal is static once sent and says nothing about who read it. ### Can I build a project with AI? Yes. Describe the pursuit in [AI Chat](https://docs.foveate.com/docs/ai-chat) and Foveate proposes a plan for the project and what to build inside it; nothing is created until you confirm the plan. ### How do I track the health of several pursuits at once? Set each project's status to on track, at risk, or off track. Those statuses roll up into the pipeline view in [Insights](https://docs.foveate.com/docs/insights), so every active pursuit's health is visible in one place. ## Related on foveate.com - [Project Rooms](https://foveate.com/project-rooms/): A secure digital sales room and virtual data room for every pursuit. - [Architecture proposal software](https://foveate.com/architecture-proposal-software/): The pursuit workflow end to end: decide what to pursue, who decides, and what to submit. - [Interactive proposals](https://foveate.com/interactive-proposals/): What interactive proposals are and how they replace the PDF. - [What Is a Digital Sales Room, and Why Design Firms Use Them](https://foveate.com/blog/digital-sales-rooms-architecture-firms/) - [How to Write an Architecture RFP Response That Wins](https://foveate.com/blog/how-to-write-architecture-rfp-response/) - [How to Find the Hidden Stakeholders in AEC Projects](https://foveate.com/blog/how-to-identify-stakeholders-architecture/) --- # Decks Source: https://docs.foveate.com/docs/decks Section: Features > Build slide-based decks, add media, present full-screen, and export to PDF. Decks are Foveate's slide-based format — one idea per slide, made for presenting. They live inside a [project](https://docs.foveate.com/docs/projects) and can be shared and collected for feedback. For long-form, section-based, client-facing content — scopes, pricing, deliverables, and detailed pitches — use a [project](https://docs.foveate.com/docs/projects) instead. Projects are the section builders (virtual data rooms) that hold everything for an engagement in one scrolling, navigable place. ## Creating a deck Start a deck two ways: - Describe it in the [AI Chat](https://docs.foveate.com/docs/ai-chat) composer ("create a kickoff deck for the Aria Hotel project") and let Foveate draft it. - Use the **New** button and pick the deck format. ## The editor Open a deck to edit it. Add, reorder, and remove slides, edit text in place, and apply a theme to control colors and fonts across the whole deck. ## Adding media Decks aren't limited to text. You can add: - **Images** — uploaded or generated. - **Video** — including hosted video playback. - **3D** — interactive previs and models embedded directly in a slide. ## Templates Start from a template to get a structured layout you can fill in, rather than building every slide from scratch. Templates cover common slide types like scope, deliverables, pricing, ROI, and timeline. ## Editing text Text uses a **double-click-to-edit** model. Text is shown as plain, selectable text by default; double-click a field to turn it into an editable input, then click away or press Enter to save. Because text stays selectable when you're not editing, viewers can highlight any passage to attach feedback — see [Sharing & feedback](https://docs.foveate.com/docs/sharing). ## Presenting and exporting When a deck is ready, present it full-screen, or export it to PDF to send a static copy. To share an interactive, trackable version instead, publish a share link — see [Sharing & feedback](https://docs.foveate.com/docs/sharing). ## Frequently asked questions ### Can I make an architecture presentation with 3D models and video in Foveate? Yes. A Foveate deck can mix slides of text and images with hosted video and interactive 3D — previs scenes and models embedded directly in a slide — so a client can explore the design during the presentation instead of looking at screenshots of it. See [interactive presentations](https://foveate.com/presentations/) on foveate.com. ### Can AI create a presentation deck from a prompt? Yes. Describe the deck in [AI Chat](https://docs.foveate.com/docs/ai-chat) — for example, "create a kickoff deck for the Aria Hotel project" — and Foveate drafts a plan, then builds the deck once you confirm it. Generating a deck uses [AI credits](https://docs.foveate.com/docs/credits-billing). ### Can I export a Foveate deck to PDF? Yes. Export any deck to PDF when a client or procurement process requires a static file, and publish a share link when you want the interactive version with engagement tracking. ### What is the difference between a deck and a project in Foveate? A deck is a slide-by-slide presentation made for presenting. A [project](https://docs.foveate.com/docs/projects) is a scrolling, section-based data room for a whole client engagement, and decks usually live inside one. ### Is Foveate an alternative to PowerPoint for architects? Foveate is often used in place of PowerPoint or Keynote when a presentation needs 3D, video, access control, or proof of who viewed it; foveate.com's [PowerPoint vs Foveate](https://foveate.com/compare/powerpoint-vs-foveate/) comparison covers when each fits. ## Related on foveate.com - [Interactive presentations](https://foveate.com/presentations/): Decks with 3D, video, per-stakeholder access controls, and changes by prompt. - [Architecture presentation software](https://foveate.com/architecture-presentation-software/): A complete guide to presenting design work as a link, not a file. - [PowerPoint vs Foveate](https://foveate.com/compare/powerpoint-vs-foveate/): Slide deck or interactive proposal: when each one fits. - [Interactive Architecture Presentations vs. PDF Proposals](https://foveate.com/blog/interactive-presentations-vs-pdf-proposals/) - [Architecture Presentation Tips That Win Clients](https://foveate.com/blog/architecture-presentation-tips/) - [Best Presentation Software for Architects](https://foveate.com/blog/best-presentation-software-architects/) - [Why PowerPoint Is Costing Architecture Firms Projects](https://foveate.com/blog/powerpoint-architecture-proposals/) --- # Forms Source: https://docs.foveate.com/docs/forms Section: Features > Build intake and feedback forms, share them, and read the responses. Forms are Foveate's way to collect structured input from clients and stakeholders — intake questionnaires, feedback surveys, and requests. They attach to a [project](https://docs.foveate.com/docs/projects) so responses stay tied to the right engagement. ## Creating a form Start a form two ways: - Describe it in the [AI Chat](https://docs.foveate.com/docs/ai-chat) composer ("build an intake form for new hotel projects") and let Foveate draft the questions. - Use the **New** button and pick the form format, then add questions yourself. ## Question types Build a form from a mix of question types — short text, long text, multiple choice, and more — to capture exactly the input you need. Add, reorder, and remove questions, and mark the ones that are required. ## Theming Apply a theme to control the form's colors and fonts so it matches your brand when a client fills it out. ## Sharing a form Publish a share link to send the form to respondents. The link opens a clean, viewer-facing version — just the questions, no editing tools. See [Sharing & feedback](https://docs.foveate.com/docs/sharing) for access controls and tracking. ## Reading responses Open a form's **results** to see every submission. Review responses individually or in aggregate to spot patterns across everyone who replied, then follow up from there. Analytics on how the form is performing roll up into [Insights](https://docs.foveate.com/docs/insights). ## Credits Using the AI to draft a form or generate questions consumes AI credits. Collecting and reading responses does not. See [Credits & billing](https://docs.foveate.com/docs/credits-billing) for details. ## Frequently asked questions ### What is a client intake form for an architecture or design firm? A client intake form is a questionnaire a firm sends at the start of a relationship to capture a prospective client's goals, program, budget, timeline, and decision-makers. In Foveate, an intake form is shared as a link, and its responses stay attached to the client's project; on foveate.com, [client intake forms](https://foveate.com/forms/) also feed the Client Profiler. ### Can AI write the questions for a client intake form? Yes. Describe the form in [AI Chat](https://docs.foveate.com/docs/ai-chat) — for example, "build an intake form for new hotel projects" — and Foveate drafts the questions for you to edit. Drafting with AI uses credits; collecting and reading responses does not. ### Do respondents need a Foveate account to fill out a form? No. A shared Foveate form opens as a clean web page with just the questions, so clients and stakeholders can respond from their browser without an account. ### Where do I see form responses? Open the form's results to review every submission individually or in aggregate. How the form is performing also rolls up into [Insights](https://docs.foveate.com/docs/insights). ## Related on foveate.com - [Client intake forms](https://foveate.com/forms/): Intake and qualification forms whose responses feed the Client Profiler. - [Client Profiler](https://foveate.com/client-profiler/): AI profiles of each stakeholder on a pursuit. - [The “Difficult Client” Who Wasn’t Difficult](https://foveate.com/blog/casestudy-ramonaalbert/) - [How Architecture Firms Decide Which RFPs to Pursue](https://foveate.com/blog/go-no-go-decision-framework-architecture/) - [How to Get Clients to Value Design](https://foveate.com/blog/how-to-get-clients-value-design/) --- # Previs Source: https://docs.foveate.com/docs/previs Section: Features > Build interactive 3D previs scenes — models, screens, and timed video cues you can present and share. Previs is Foveate's interactive 3D format — a scene where a 3D model, media screens, and a timeline come together into a presentable, navigable experience. Use it to walk a client through a concept in space rather than on slides. Previs attach to a [project](https://docs.foveate.com/docs/projects) and can be shared and collected for feedback. ## Creating a previs Start a previs two ways: - Describe it in the [AI Chat](https://docs.foveate.com/docs/ai-chat) composer and let Foveate set up the scene. - Use the **New** button and pick the previs format, then load your model. ## The editor Open a previs to edit it. Position the camera, place media on screens in the scene, and organize the moment-to-moment flow with cues and a timeline. Video and image clips can play on individual screens or surfaces, driven by the timeline. ## Cues and the timeline Build the experience as a sequence of **cues** — saved camera and content states you can step through when presenting. The **timeline** drives per-screen video and image playback so media plays in sync with the scene. Loop the timeline for a continuous ambient playback, or step cue by cue when walking someone through it live. ## Presenting and sharing Present a previs full-screen to navigate it live, or publish a share link for an interactive, trackable version viewers can explore on their own. See [Sharing & feedback](https://docs.foveate.com/docs/sharing) for access controls and engagement tracking, and [Walkthroughs](https://docs.foveate.com/docs/walkthroughs) for navigable models and scans. ## Credits Using the AI to generate media or help build a scene consumes AI credits. See [Credits & billing](https://docs.foveate.com/docs/credits-billing) for details. ## Frequently asked questions ### What is 3D previs? 3D previs (previsualization) is a way to see how media and a space will work together before anything is built, installed, or loaded in. In Foveate, a previs is an interactive 3D scene that combines a model, screens and surfaces, and a timeline of video and image cues — used for stage and LED-wall content, projection, experiential installations, and walking a client through a concept in space. See [previsualization](https://foveate.com/previs/) on foveate.com. ### What is the difference between previs, a 3D walkthrough, and a flythrough? A Foveate previs is a directed experience: saved camera cues and a timeline that plays media in sync with the scene. A [3D walkthrough](https://docs.foveate.com/docs/walkthroughs) is free exploration, where the viewer moves through the model at their own pace. A flythrough is a rendered video along a fixed camera path — watched rather than explored — and can play on a screen inside a previs or in a deck. ### Can I preview video content on LED walls or screens in a 3D model? Yes. In a Foveate previs, video and image clips play on individual screens or surfaces in the 3D scene, driven by the timeline, so you can check how content reads in the space before load-in. ### Can clients view a previs without installing software? Yes. Publish a share link and clients explore the previs in their browser with no install; the link can track who viewed it — see [Sharing & feedback](https://docs.foveate.com/docs/sharing). ## Related on foveate.com - [Previsualization](https://foveate.com/previs/): Map video to LED walls, projections, and screens before load-in. - [Foveate for event production](https://foveate.com/solutions/events/): Immersive bid proposals with venue walkthroughs. - [Foveate for experiential design](https://foveate.com/solutions/experiential-design/): Immersive pitches with protected, expiring links. - [The Best 3D Previs Software for Every Media Server](https://foveate.com/blog/best-3d-previs-software-media-server-2026/) - [Case Study: Toy Robot Media and 360° Content for Zyn](https://foveate.com/blog/casestudy-toy-robot-zyn-miami/) - [Case Study: 125 Combinations, Zero Renders for a Stadium Production](https://foveate.com/blog/toy-robot-stadium/) - [Case Study: BUILDING at Pioneer Works](https://foveate.com/blog/casestudy-building-pioneer-works/) --- # Walkthroughs Source: https://docs.foveate.com/docs/walkthroughs Section: Features > Share navigable 3D models and scans clients can explore on their own. Walkthroughs are navigable 3D models and scans — a space or object a client can orbit, pan, and move through at their own pace. Where a [previs](https://docs.foveate.com/docs/previs) is a directed, timed experience, a walkthrough is free exploration of a model. Walkthroughs attach to a [project](https://docs.foveate.com/docs/projects) and can be shared and collected for feedback. ## Creating a walkthrough Start a walkthrough two ways: - Describe it in the [AI Chat](https://docs.foveate.com/docs/ai-chat) composer and let Foveate set it up. - Use the **New** button and pick the walkthrough format, then load your model or scan. ## Viewing and navigating Open a walkthrough to orbit, pan, and zoom around the model. The viewer supports both standard 3D models and Gaussian-splat scans, and adapts to light and dark mode. ## Presenting and sharing Present a walkthrough full-screen, or publish a share link so viewers can explore the model themselves in a clean, viewer-facing version. See [Sharing & feedback](https://docs.foveate.com/docs/sharing) for access controls and engagement tracking. ## Credits Using the AI to help prepare or generate content consumes AI credits. Viewing and navigating a walkthrough does not. See [Credits & billing](https://docs.foveate.com/docs/credits-billing) for details. ## Frequently asked questions ### What is a 3D walkthrough in architecture? A 3D walkthrough is an interactive view of a building, interior, or site that a client can orbit, pan, and move through at their own pace. In Foveate, a walkthrough runs in the browser from a share link, so a client explores the design without downloading a file or installing software. See [3D walkthroughs](https://foveate.com/walkthroughs/) on foveate.com. ### What 3D file formats does Foveate support for walkthroughs? Foveate walkthroughs support 3D models in glTF and GLB format and Gaussian-splat (3DGS) scans. Foveate does not keep a live link to Revit, Rhino, or SketchUp, so export the model to glTF or GLB first. ### What is the difference between a 3D walkthrough and a flythrough video? A flythrough is a rendered video that follows a fixed camera path, so every viewer sees the same shots in the same order. A 3D walkthrough lets each viewer control the camera and look at what matters to them. Foveate handles both: navigable models as walkthroughs, and flythrough videos rendered in tools like Enscape, Twinmotion, D5 Render, or Lumion in [decks](https://docs.foveate.com/docs/decks) and [previs](https://docs.foveate.com/docs/previs). ### How do I share a Revit or Rhino model with a client online? Export the model from Revit or Rhino to glTF or GLB, create a walkthrough in Foveate, and publish a share link. The client opens the model in their browser, and [Insights](https://docs.foveate.com/docs/insights) shows who viewed it. foveate.com's guide on [presenting Revit and Rhino models online](https://foveate.com/blog/present-revit-rhino-models-online/) walks through the workflow. ## Related on foveate.com - [3D walkthroughs](https://foveate.com/walkthroughs/): GLB and glTF models, Gaussian splats, and 360 virtual tours in the browser. - [Foveate for archviz studios](https://foveate.com/solutions/archviz/): 360 tours, fly-through videos, and image galleries with viewer tracking. - [Platform overview](https://foveate.com/overview/): The whole platform: presentations, 3D, share links, and engagement tracking. - [How to Present Revit and Rhino Models Online](https://foveate.com/blog/present-revit-rhino-models-online/) - [Client Presentation Mistakes Architecture Firms Make](https://foveate.com/blog/client-presentation-mistakes-architecture-firms/) - [Interactive Storytelling for Architecture Firms](https://foveate.com/blog/interactive-storytelling-architecture-firms/) - [PDF Alternatives for Architecture Proposals](https://foveate.com/blog/pdf-alternatives-architecture-proposals/) --- # AI Chat Source: https://docs.foveate.com/docs/ai-chat Section: Features > The AI composer that turns a prompt into a plan and builds decks, forms, walkthroughs, and previs. AI Chat is the composer on the home screen — a single prompt you can use to ask a question, generate media, or kick off a build without choosing a tool first. Describe what you want and Foveate routes it to the right place. ## How a prompt is interpreted Foveate reads your prompt and decides what you're asking for: - **Ask a question** — get an answer about your work ("what's on track this week", "summarize the responses to my intake form"). - **Generate media** — create an image or other asset to use in your work. - **Build a plan** — turn a request like "create a kickoff deck for the Aria Hotel project" into a concrete plan of what to build. ## Mentioning existing items Use `@` to mention existing projects, decks, forms, and other items in your prompt. This gives Foveate context — you can reference a project to build inside it, or point at an existing deck to extend or reuse it. ## Confirming a build plan When your prompt calls for building something, Foveate proposes a plan first — what it will create and how the pieces fit together. Review the plan and confirm it before anything is built, so you stay in control of the result. ## What it can build From a single prompt, AI Chat can create: - **[Projects](https://docs.foveate.com/docs/projects)** — a new section-based data room for an engagement. - **[Decks](https://docs.foveate.com/docs/decks)** — slide-based presentations. - **[Forms](https://docs.foveate.com/docs/forms)** — intake and feedback forms. - **[Walkthroughs](https://docs.foveate.com/docs/walkthroughs)** — navigable 3D experiences. - **[Previs](https://docs.foveate.com/docs/previs)** — interactive 3D scenes. ## Credits Generation consumes AI credits — drafting a deck, creating an image, or building a plan draws from your balance. See [Credits & billing](https://docs.foveate.com/docs/credits-billing) for how credits and plans work. ## Frequently asked questions ### What can Foveate's AI build from a prompt? Foveate's AI Chat can build projects (section-based data rooms), slide decks, intake and feedback forms, 3D walkthroughs, and interactive 3D previs from a single prompt. It can also answer questions about your work and generate images. ### Does Foveate's AI build anything without my approval? No. When a prompt calls for building something, Foveate's AI Chat first proposes a plan of what it will create, and nothing is built until you review and confirm that plan. ### Can the AI use my existing projects and decks as context? Yes. Type `@` in the composer to mention an existing project, deck, or form, and Foveate uses it as context — to build inside that project or to extend an existing deck. ### Does using AI in Foveate cost credits? Yes. AI generation — drafting decks, forms, and plans, or creating images — uses AI credits. Viewing, editing, sharing, and reading analytics do not. See [Credits & billing](https://docs.foveate.com/docs/credits-billing). ## Related on foveate.com - [Platform overview](https://foveate.com/overview/): The whole platform: presentations, 3D, share links, and engagement tracking. - [Interactive presentations](https://foveate.com/presentations/): Decks with 3D, video, per-stakeholder access controls, and changes by prompt. - [RFP Research](https://foveate.com/rfp-research/): Talk to an RFP, match it against your team, and get a go/no-go. - [AI Proposal Writing Tools for AEC Firms](https://foveate.com/blog/ai-proposal-writing-tools-aec/) - [Using AI to Find Your Ideal Architecture Clients](https://foveate.com/blog/use-ai-to-find-ideal-architecture-clients/) - [Will AI Replace Architects?](https://foveate.com/blog/will-ai-replace-architects/) --- # Insights Source: https://docs.foveate.com/docs/insights Section: Features > See how your shared work is performing — views over time, who engaged, and pipeline health. Insights shows how your shared work is performing. Once you publish a share link, Foveate tracks engagement so you can see what's landing and follow up at the right moment. ## Views over time See how views accumulate over time across your shared projects, decks, previs, walkthroughs, and forms. Trends tell you when interest is building and when a pursuit has gone quiet. ## Who engaged For links that ask viewers to identify themselves, Insights shows **who opened the link** and how they engaged — which items they spent time on and how far they got. This turns an anonymous view count into a signal about specific people and accounts. ## Per-item analytics Open the **Analytics modal** on any individual item to see its own numbers in detail — views, viewers, and engagement for that specific project, deck, or scene, separate from your overall totals. ## Pipeline and pursuits Insights also gives you a pipeline view of your pursuits, drawing on the **status** you set on each [project](https://docs.foveate.com/docs/projects) (on track, at risk, off track). Use it to see the health of every active engagement in one place. ## Following up The point of Insights is action. When you see that a stakeholder opened your data room, or that a link has gone cold, you know exactly when and who to follow up with. Pair this with [Sharing & feedback](https://docs.foveate.com/docs/sharing) to send reminders and collect responses. ## Frequently asked questions ### How do I know if a client read my architecture proposal? Share the proposal from Foveate as a link instead of a PDF attachment, and turn on the option that asks viewers for their name and email. Foveate Insights then shows who opened the link, which items they spent time on, and how far they got. See [proposal insights](https://foveate.com/insights/) on foveate.com. ### Can Foveate show which stakeholders engaged with a proposal? Yes. For share links that ask viewers to identify themselves, Foveate Insights ties each view to a named person, so a view count becomes a record of which stakeholders engaged and with what. ### What analytics does Foveate show for a single deck or project? The Analytics modal on any individual project, deck, previs, walkthrough, or form shows that item's own views, viewers, and engagement, separate from your overall totals. ### What does the pipeline view in Foveate Insights show? The pipeline view shows the health of every active pursuit, based on the status set on each [project](https://docs.foveate.com/docs/projects): on track, at risk, or off track. ## Related on foveate.com - [Proposal insights](https://foveate.com/insights/): See who opened a proposal, what held their attention, and when to follow up. - [Stakeholder Networks](https://foveate.com/stakeholder-networks/): Map the decision-making network and simulate the room. - [Client Profiler](https://foveate.com/client-profiler/): AI profiles of each stakeholder on a pursuit. - [What Happens After You Send an Architecture Proposal?](https://foveate.com/blog/architecture-proposal-tracking-engagement-intelligence/) - [How to Track Whether Clients Read Your Proposal](https://foveate.com/blog/how-to-track-clients-read-architecture-proposal/) - [What Is Stakeholder Mapping for Architecture Firms?](https://foveate.com/blog/stakeholder-mapping-architecture-firms/) - [How to Build a Win/Loss Analysis System](https://foveate.com/blog/win-loss-analysis-architecture-firms/) --- # Sharing & feedback Source: https://docs.foveate.com/docs/sharing Section: Features > Publish a share link, control who can view, collect highlighted feedback, and track opens. Sharing turns anything you build in Foveate — a project data room, a deck, a previs, a walkthrough, a form — into a link you can send to clients and stakeholders, then collect feedback and track engagement on it. ## Creating a share link Open the item you want to share and publish a share link. The link opens a clean, viewer-facing version of your work — no editing tools, just the content as your audience should see it. ## Controlling access Choose how open the link is: - **Public** — anyone with the link can view. - **Restricted** — access is limited to specific viewers. You can also **require a viewer's name and email** before they see the content. This gates access lightly and, importantly, ties engagement to real people so you can see exactly who viewed what in [Insights](https://docs.foveate.com/docs/insights). ## Sending by email and tracking opens Send a share link by email directly from Foveate. When you do, Foveate can track when recipients open it, so you know your work reached the right person and when. ## Collecting feedback and comments Viewers can leave feedback right on the content using the **highlight-to-comment** system: they select any passage of text, and a small action button appears to attach a comment to that exact highlight. Feedback comes back anchored to the specific line it refers to, so you always know what a comment is about. The same system works for you and your team in the editor. ## Reminders For links that have gone quiet, send a reminder to nudge viewers to open or respond. Combined with the engagement data in [Insights](https://docs.foveate.com/docs/insights), reminders help you follow up at the right time without guessing. ## Frequently asked questions ### How do I share a proposal or 3D model with a client without sending files? Publish a Foveate share link for the project, deck, walkthrough, previs, or form and send the link instead of an attachment. The client opens a clean, viewer-facing version in their browser, and you can see when it's opened. ### Can I require viewers to enter their name and email before viewing? Yes. A Foveate share link can require a viewer's name and email before the content appears, which lightly gates access and ties every view to a real person in [Insights](https://docs.foveate.com/docs/insights). ### Can I restrict who can open a share link? Yes. Set a Foveate share link to public, so anyone with the link can view, or restricted, so only specific viewers can. ### How do clients leave feedback on a proposal in Foveate? Clients leave feedback by highlighting any passage of text in the shared work and attaching a comment to that highlight. Each comment comes back anchored to the exact line it refers to. ### When should I follow up after sending a proposal? Follow up when the engagement data gives you a reason: Foveate shows when a recipient opened the link, and a reminder can nudge links that have gone quiet. foveate.com's article on [architecture proposal follow-up](https://foveate.com/blog/architecture-proposal-follow-up/) covers what to say. ## Related on foveate.com - [Project Rooms](https://foveate.com/project-rooms/): A secure digital sales room and virtual data room for every pursuit. - [Interactive presentations](https://foveate.com/presentations/): Decks with 3D, video, per-stakeholder access controls, and changes by prompt. - [Proposal insights](https://foveate.com/insights/): See who opened a proposal, what held their attention, and when to follow up. - [How to Track Whether Clients Read Your Proposal](https://foveate.com/blog/how-to-track-clients-read-architecture-proposal/) - [What Is a Digital Sales Room, and Why Design Firms Use Them](https://foveate.com/blog/digital-sales-rooms-architecture-firms/) - [Architecture Proposal Follow-Up That Works](https://foveate.com/blog/architecture-proposal-follow-up/) --- # Credits & billing Source: https://docs.foveate.com/docs/credits-billing Section: Account > How AI credits power generation, where to check your balance, and how to manage your plan. AI credits power Foveate's generation features. Anything that asks the AI to create something for you — drafting a deck, generating an image, building a plan in [AI Chat](https://docs.foveate.com/docs/ai-chat) — draws from your credit balance. ## What uses credits Generation consumes credits. This includes things like: - Building a plan and generating decks, forms, walkthroughs, or previs. - Generating images and other media. - Other AI-assisted drafting and creation. Everyday actions like viewing, editing, sharing, and reading analytics don't consume credits — only the AI generation itself does. ## Checking your balance See your current credit balance and recent usage on the **Credits** page. This is where you can track how much you've used and how much remains. ## Running low When you don't have enough credits for an action, Foveate shows an insufficient-credits prompt before running it, so you're never surprised by a failed generation. From there you can top up or adjust your plan and try again. ## Plans and tiers Foveate offers different plans, and your plan determines how many credits you have to work with along with the features available to you. Higher tiers include more generation capacity. ## Managing billing Manage your plan and billing details in [Settings](https://docs.foveate.com/docs/account-settings). That's where you upgrade, change your plan, and update payment information. ## Frequently asked questions ### What are AI credits in Foveate? AI credits are the balance Foveate draws from when its AI creates something for you — drafting a deck, form, or plan, or generating an image. Your plan sets how many credits you have. ### What does not use AI credits in Foveate? Viewing, editing, sharing, collecting form responses, and reading analytics in Foveate do not use AI credits. Only AI generation does. ### Is there a free Foveate plan? Yes. Foveate has a free plan that includes starter AI credits, and paid plans add more monthly credits and team members. Current plans and prices are on [foveate.com/pricing](https://foveate.com/pricing/). ### What happens if I run out of AI credits? Foveate shows an insufficient-credits prompt before running an AI action you can't cover, so a generation never fails partway. From that prompt you can top up or change your plan and try again. ## Related on foveate.com - [Pricing](https://foveate.com/pricing/): Plans, monthly AI credits, and team seats. - [Foveate FAQ](https://foveate.com/faq/): Answers about interactive proposals, tracking, and plans. - [Enterprise](https://foveate.com/enterprise/): Custom AI billing and scale for larger firms. - [AI Proposal Writing Tools for AEC Firms](https://foveate.com/blog/ai-proposal-writing-tools-aec/) - [AEC Win Rates: What Drives the Gap](https://foveate.com/blog/aec-win-rate-architecture-firms/) --- # Account & settings Source: https://docs.foveate.com/docs/account-settings Section: Account > Manage your profile, appearance, team access, and find support and documentation. Settings is where you manage your profile, how the app looks, and who on your team has access. ## Profile Set your **name** and **profile picture** so your work and comments are attributed to you across the app. Your profile is how teammates and clients recognize you in shared and collaborative surfaces. ## Appearance Foveate supports both light and dark mode. Toggle your preference from the appearance control; your choice is **remembered per device**, so each machine you use can keep its own setting. ## Team members and access Manage the people on your team and what they can reach. Team members can be given access to [projects](https://docs.foveate.com/docs/projects) so they can view and edit the decks, previs, walkthroughs, forms, and files inside them. Use this to bring collaborators into an engagement. ## Preferences Where available, adjust your notification and other account preferences to control what Foveate sends you and how it behaves. ## Billing Your plan and billing details are managed here too — see [Credits & billing](https://docs.foveate.com/docs/credits-billing) for how credits and plans work. ## Support and documentation Find help without leaving the app: - Use the **Help / Feedback** button in the header to send a report straight to the team. - Open this **Documentation** to browse guides for every feature. - [Contact the Foveate team](https://foveate.com/contact/) for further help. ## Frequently asked questions ### Can I add my team to Foveate? Yes. Invite team members to your Foveate workspace and give them access to projects so they can view and edit the decks, previs, walkthroughs, forms, and files inside. How many members a workspace can have depends on the plan — see [foveate.com/pricing](https://foveate.com/pricing/). ### Where can I find Foveate's security and compliance information? Foveate's security, legal, and compliance documents are in the [Trust center](https://foveate.com/trustcenter/), and the [Security](https://foveate.com/security/) page explains how Foveate protects your work and your clients' data. ### Does Foveate have a dark mode? Yes. Foveate supports light and dark mode, and your choice is remembered on each device you use. ## Related on foveate.com - [Pricing](https://foveate.com/pricing/): Plans, monthly AI credits, and team seats. - [Trust center](https://foveate.com/trustcenter/): Security, legal, and compliance documents. - [Security](https://foveate.com/security/): How Foveate protects your work and your clients’ data. - [Scaling Architecture Proposals Without More Staff](https://foveate.com/blog/architecture-proposal-operations-efficiency/) --- # API Source: https://docs.foveate.com/docs/api Section: Developers > Create, generate, and manage decks from your own tools with the Foveate REST API. The Foveate REST API lets you create and manage [decks](https://docs.foveate.com/docs/decks) from your own tools — a CRM, an automation platform like Zapier, an internal script, or an AI agent. Every endpoint lives under: ``` https://app.foveate.com/api/v1/ ``` The API is versioned. Anything documented here under `v1` is a compatibility promise; the web app's own internal routes are not. ## Authentication Requests are authenticated with an API key sent as a Bearer token: ``` Authorization: Bearer fv_live__ ``` A key acts as **one user** — the person it was issued to. Requests run under their identity: their decks, their workspace, their [credits](https://docs.foveate.com/docs/credits-billing), and the same access rules the app enforces. A key never bypasses permissions. ### Creating a key 1. Open **Settings → Developer** in the app. 2. Choose **New key**, give it a name (for example, "Zapier"), and pick its permissions. 3. Copy the token. You can copy it again later from the same page, and revoke it there when you're done with it. ### Scopes Each key carries one or more scopes. A request that needs a scope the key doesn't have returns `403 insufficient_scope`. | Scope | Allows | |---|---| | `decks:read` | List decks and read a deck. | | `decks:write` | Create decks from an outline, rename, file, share, delete. | | `decks:generate` | Generate a deck from a prompt with AI (uses credits). | | `ai:run` | Run the [AI endpoints](#ai-endpoints): the assistant, RFP analysis, proposal drafting and scoring, rewriting (uses credits). | Keys can also carry read and write scopes for projects, clients, forms, files, sharing, comments, walkthroughs and Studio. The full list is shown when you create a key. A Firebase ID token is also accepted as the Bearer value, for scripts a user runs as themselves. ## Conventions - **Responses.** Success returns `{ "data": … }`. Failure returns `{ "error": { "code", "message", "requestId", "details"? } }`. - **Request IDs.** Every response carries an `x-request-id` header. Quote it when reporting a problem. - **Strict bodies.** Bodies are JSON. Objects are strict — an unknown field is a `400 validation_error`, with `details: [{ path, message }]` pointing at the offending field. - **Idempotency.** Send an `Idempotency-Key` header (any string up to 200 characters) on `POST /decks` and `POST /decks/generate`. A repeat within 24 hours returns the original response with `Idempotent-Replayed: true`. A repeat while the first request is still running returns `409 request_in_flight`. - **Rate limits.** 60 requests per minute per key. `POST /decks/generate` is limited to 5 per minute, and every [AI endpoint](#ai-endpoints) to 10 per minute. Exceeding either returns `429 rate_limited` with a `Retry-After` header. ## Endpoints ### `GET /api/v1/me` Who the credential acts as. No scope required. ```json { "data": { "user": { "uid": "…", "email": "…", "displayName": "…" }, "auth": { "kind": "api_key", "keyId": "…", "name": "Zapier", "scopes": ["decks:read", "decks:write"] } } } ``` ### `GET /api/v1/decks` — `decks:read` Your decks, newest-updated first. Query parameters: `limit` (1–100, default 25) and `cursor` (the `nextCursor` from the previous page). ```json { "data": { "decks": [ /* Deck */ ], "nextCursor": "deckId or null" } } ``` ### `POST /api/v1/decks` — `decks:write` Create a deck from an outline (see **The outline contract** below). Returns `201` with the Deck. ```bash curl -X POST https://app.foveate.com/api/v1/decks \ -H "Authorization: Bearer fv_live_…" \ -H "Idempotency-Key: order-8812" \ -H "Content-Type: application/json" \ -d '{ "name": "Riverside Library", "pageSize": { "preset": "widescreen" }, "slides": [ { "role": "cover", "content": { "title": "Riverside Library", "eyebrow": "Portland · 2027" } }, { "role": "content", "content": { "eyebrow": "The Site", "title": "A working waterfront", "body": ["The parcel sits between the rail line and the river."] } }, { "role": "metrics", "content": { "title": "By the numbers", "metrics": [{ "value": "42k", "label": "sq ft" }, { "value": "18", "label": "months" }] } }, { "role": "closing", "content": { "title": "Next step", "subtitle": "Schedule the site walk" } } ] }' ``` ### `POST /api/v1/decks/generate` — `decks:generate` Generate a deck from a prompt with AI. The call is **synchronous and can take up to about 120 seconds**, so always send an `Idempotency-Key`. Generation bills the key owner's [credits](https://docs.foveate.com/docs/credits-billing) at the deck generation rate. The response includes `creditsCharged` and the `outline` the model wrote. If the balance can't cover the deck, the API returns `402 insufficient_credits`. Body fields: | Field | Notes | |---|---| | `prompt` | Required. The brief. | | `name` | Optional deck title. | | `type` | `proposal`, `sales`, `casestudy`, `meeting`, `pitch`, `competition`, `update`, or `partnership`. | | `industry` | Steers templates and stock imagery. | | `slideCount` | 1–60. | | `projectId` | File the deck in a [project](https://docs.foveate.com/docs/projects). | | `pageSize`, `theme`, `placeholderImages` | Same as the deck-level options below. | ### `GET /api/v1/decks/{id}` — `decks:read` A deck you can see in the app — yours, shared with you, or in a workspace you own. Add `?include=slides` to get the internal slide model (large; its shape is not part of the v1 contract). Unknown or invisible decks return `404`. ### `PATCH /api/v1/decks/{id}` — `decks:write` Owner only. Fields: `name`, `description`, `projectId` (nullable), `isPublic`. ### `DELETE /api/v1/decks/{id}` — `decks:write` Owner only. Deleting a deck that's already gone succeeds. ### `GET /api/v1/schemas` — no auth The request contracts as JSON Schema (draft 2020-12), generated from the server's own validator, with a description on every field. Returns `{ version, roles, deckTypes, pageSizePresets, schemas: { createDeck, generateDeck, patchDeck, outlineSlide } }`. Use it for structured-output prompting or client-side validation (see **Using the JSON Schema** below). ## AI endpoints These endpoints run Foveate's AI on your behalf. They all take `POST`, need the `ai:run` scope, and allow 10 calls a minute. Each spends the key owner's [credits](https://docs.foveate.com/docs/credits-billing) at the action's floor and then the token price, and returns `402 insufficient_credits` when the balance can't cover it. The full request and response shape for each is in the OpenAPI 3.1 document at `GET /api/v1/openapi.json` (no auth). Where an endpoint takes `sources`, pass an array of documents as `{ name, text }`, the RFP first. Where it takes `rfpText`, pass the RFP's extracted text and, optionally, `rfpName`. ### The assistant `POST /api/v1/ai/assist` hands one message to the assistant a Foveate user has in the app and returns its reply. It is the same operation as the connector's `ask_foveate` tool (see [Connect Claude](https://docs.foveate.com/docs/connect-claude)). Body: `{ surface, message, objectId?, threadId?, sources?, context?, web? }`. Response: `{ surface, threadId, text, data?, toolResults?, creditsUsed }`. | `surface` | What it does | `objectId` | |---|---|---| | `workspace` | The user's whole workspace: looks things up, creates decks, projects, forms and clients, answers questions about the pipeline. | — | | `research` | Cited answers over RFP documents you pass as `sources`, or over a project's research documents. | Project id, optional | | `form-editor` | Edits a form: adds, changes, moves and removes questions. | Form id | | `client-profile` | Writes the client's psychological and deal profile onto their record. | Client id | `context` is what the team already knows. The assistant uses it but never cites it. `web: true` lets it search the live web this turn. Pass the `threadId` from a response back in the next request to continue the conversation. Foveate keeps the transcript, and credits are charged at the surface's rate. ### RFP steps Each step reads the package itself and reports when a document was longer than its reading window. | Endpoint | Body | Returns | |---|---|---| | `POST /api/v1/ai/rfp/findings` | `{ sources }` | The key pursuit facts (client, scope, deadline, budget, evaluation, submission rules, insurance, contacts), each cited. | | `POST /api/v1/ai/rfp/requirements` | `{ rfpText, rfpName? }` | Every requirement a proposal must satisfy: content, format and contractual, with the source clause. | | `POST /api/v1/ai/rfp/entities` | `{ sources }` | The project, the issuing client, the due date, the value and every named person, structured. | | `POST /api/v1/ai/rfp/plan` | `{ sources, keyFindings?, goNoGo?, fitSummary?, firmProfile? }` | The sections to write in the RFP's order with owners and weights, a calendar back-planned from the deadline, and open questions for the issuer. | | `POST /api/v1/ai/rfp/fit` | `{ rfpText, portfolio?, team?, proposals?, firm? }` | The decisive requirements matched to the firm's real projects, people and past proposals, with gaps and risks. Omit the evidence and it reads Studio. | | `POST /api/v1/ai/rfp/coverage` | `{ rfpText, slides, requirements? }` | Which rows of a deck outline already answer the RFP, and what is still owed. | | `POST /api/v1/ai/proposal/compliance` | `{ rfpText, sections, requirements? }` | Each requirement judged against the draft: covered, partial or missing, with the specific gap. | | `POST /api/v1/ai/proposal/score` | `{ rfpText, sections, evaluation?, requirements? }` | A score per evaluation criterion with evidence and the one change that would raise it. | | `POST /api/v1/ai/proposal/draft` | `{ rfpText, rfpName?, … }` | Answers `202` with a job. The job's result holds the written proposal's sections. | Drafting runs in the background. Poll `GET /api/v1/jobs/{id}` with the job id from the `202` response until its status is `succeeded` (with `result`) or `failed` (with `error`). Reading a job needs the scope of the operation that started it. ### Writing and generation | Endpoint | Body | Returns | |---|---|---| | `POST /api/v1/ai/text/rewrite` | `{ passage, instruction?, sectionTitle?, context?, checklist? }` | The passage rewritten in the RFP's own language, as plain text. | | `POST /api/v1/ai/deck/rewrite` | `{ document, instruction }` | The deck's copy rewritten. Returns only the blocks that changed, by id. | | `POST /api/v1/ai/deck/labels` | `{ rfpName?, slides }` | A deck title and a short kicker per slide. | | `POST /api/v1/forms/generate` | `{ brief?, sourceText?, create?, projectId? }` | A form's name, description and questions. With `create: true` the draft form is made and returned. | | `POST /api/v1/clients/{id}/profile` | `{ context? }` | The client's psychological profile from their notes and your context, saved onto the record with the previous profile archived. | | `POST /api/v1/media/prompt/enhance` | `{ prompt }` | An image or video prompt expanded with visual detail. | | `POST /api/v1/media/prompt/safety` | `{ prompt, rejection? }` | A prompt the provider's safety filter rejected, rewritten to pass while keeping the scene. | ## The Deck object ```json { "id": "…", "name": "…", "description": "…", "projectId": null, "workspaceId": "…", "isPublic": false, "aspectRatio": "16:9", "pageSize": { "preset": "widescreen", "w": 1920, "h": 1080, "phys": null }, "theme": { }, "slideCount": 4, "createdAt": "ISO 8601", "updatedAt": "ISO 8601", "urls": { "edit": "https://app.foveate.com/deck/{id}", "share": "https://app.foveate.com/share/deck/{id}" } } ``` ## The outline contract A slide is `{ "role", "content" }`. The role picks the layout; the content is the text. Foveate lays the slide out — you never position elements. | Role | Content fields | |---|---| | `cover` | `title`, `eyebrow` (location · year, or the client) | | `section` | `eyebrow`, `title`, `subtitle?` | | `statement` | `title` (one bold sentence), `subtitle?` | | `content` | `eyebrow`, `title`, `body[]` (1–3 complete statements) | | `metrics` | `title`, `metrics[{ value, label }]` (2–3) | | `timeline` | `title`, `phases[{ date, title }]` (3–5) | | `features` | `title`, `features[{ title, description }]` (3) | | `image` | `title` or `body[]` as the caption; the image is a placeholder | | `closing` | `title`, `subtitle` (the call to action) | Every slide may also carry `notes` — speaker notes shown only to the presenter, never rendered on the slide. Limits: `title` up to 200 characters, `eyebrow` up to 60, `subtitle` up to 200, `body` up to 12 items of up to 1,000 characters each, and up to 120 slides per deck. ### Deck-level options | Field | Notes | |---|---| | `description` | Shown alongside the deck. | | `projectId` | File the deck in a [project](https://docs.foveate.com/docs/projects). | | `pageSize` | `{ "preset": "widescreen" \| "standard-4-3" \| "square" \| … }` or `{ "w", "h" }`. The full preset list is in `GET /api/v1/schemas`. | | `theme` | `backgroundColor` and `accentColor` as hex, plus `headingFont`, `bodyFont`, `palette`. | | `industry` | Steers templates and stock imagery. | | `placeholderImages` | Set `false` to leave image slots empty instead of filling them with stock photos. | ## Writing a good outline The schema guarantees an outline is *valid*. These rules make it *good* — and they are the same rules Foveate's own generator follows. If you're having an AI author the outline, paste this section into its instructions. 1. Exactly one `cover`, first. Exactly one `closing`, last. 2. One idea per slide. When there is more to say, add a slide — don't lengthen the body. 3. Titles up to 5 words. Eyebrows up to 20 characters, specific and different on every slide — never "Overview" or "Section", never the title repeated. 4. Body items are complete sentences in a confident, declarative voice. No fragments, no trailing "…", no bullets-as-sentences. Aim for 25–55 words per `content` slide. 5. Metric labels up to 24 characters. Phase titles up to 24. Feature titles up to 24, descriptions up to 90. 6. Use `metrics`, `timeline`, and `features` only when the brief genuinely contains numbers, a schedule, or discrete capabilities. Don't invent figures or dates to fill a layout. 7. Names, numbers, places, and dates come from the brief or the source material. Never invent a client, a firm, or a statistic. 8. Use only the fields listed for a role. The API rejects unknown fields. 9. Aim for 8–12 slides for a proposal or pitch, or follow an explicit slide count when the brief gives one. A reliable arc when the brief doesn't dictate one: cover → the context or problem → the idea in one `statement` → how it works (`content` or `features`) → proof (`metrics`, `image`) → delivery (`timeline`) → `closing` with the next step. ### A worked example Brief: *"A proposal to convert a closed 40-acre warehouse district on the Oakland waterfront into production studios. 180k sq ft, 24 months to first occupancy, we keep 62% of the existing structure. Three moves: open the long shed into bays, raise a plinth above the flood line, keep the gantry cranes as canopy structure. Entitlements Q1 2027, first studios Q1 2029. Ask them to walk the site Thursday the 14th at 9am."* ```json { "name": "Harbor Point Studios", "slides": [ { "role": "cover", "content": { "title": "Harbor Point Studios", "eyebrow": "Oakland · 2027" } }, { "role": "section", "content": { "eyebrow": "Context", "title": "A waterfront that stopped working", "subtitle": "Forty acres of closed warehouses between the port and the neighborhood" } }, { "role": "content", "content": { "eyebrow": "The Site", "title": "Between the cranes and the street", "body": [ "The parcel sits where the rail spur meets the estuary, with the working port on one side and a residential grid on the other.", "Every earlier proposal treated that seam as a problem to hide. We treat it as the reason to build here." ] } }, { "role": "statement", "content": { "title": "Production space should face the city, not turn its back on it." } }, { "role": "metrics", "content": { "title": "By the numbers", "metrics": [ { "value": "180k", "label": "sq ft of studio space" }, { "value": "24", "label": "months to first occupancy" }, { "value": "62%", "label": "of existing structure retained" } ] } }, { "role": "features", "content": { "title": "Three moves", "features": [ { "title": "Open the shed", "description": "Cut the long warehouse into three bays with public passages between them." }, { "title": "Raise the ground", "description": "A continuous plinth lifts studios above the flood line and becomes the street." }, { "title": "Keep the cranes", "description": "Two gantry cranes stay as structure for the shade canopy." } ] } }, { "role": "image", "content": { "title": "View from the estuary", "body": ["The retained shed roof reads as one long horizon; new work sits beneath it."] } }, { "role": "timeline", "content": { "title": "Delivery", "phases": [ { "date": "Q1 2027", "title": "Entitlements" }, { "date": "Q3 2027", "title": "Shed stabilization" }, { "date": "Q2 2028", "title": "Plinth and bays" }, { "date": "Q1 2029", "title": "First studios open" } ] } }, { "role": "closing", "content": { "title": "Walk the site with us", "subtitle": "Thursday the 14th, 9am — we will bring the drawings" } } ] } ``` Everything in it traces to the brief. Nothing was invented to fill a slot. ### The validation loop The API is strict, and its errors are addressed to the field, so an AI can self-correct in one round trip: 1. `POST /api/v1/decks` with the outline (plus `name`, and optionally `industry`, `pageSize`, `theme`, `placeholderImages`). 2. On `400 validation_error`, the body carries `error.details: [{ path, message }]` — for example `{ "path": "slides.2.content.metrics.1", "message": "Unrecognized key: \"month\"" }`. Feed those back to the model verbatim and ask for the corrected JSON. 3. On `201`, `data.urls.edit` opens the deck. Always send an `Idempotency-Key` on the POST so a retried request can't create the deck twice. ### Using the JSON Schema `GET /api/v1/schemas` returns each contract as draft 2020-12 JSON Schema with `additionalProperties: false` throughout and a `description` on every field. Two ways to use it: - **Structured output.** Pass `schemas.createDeck` as the response schema to a model API that supports JSON-Schema-constrained output (a Claude tool `input_schema`, OpenAI `response_format`). The model then can't emit an invalid shape, and the rules above only have to teach it to write well. - **Client-side validation.** Any JSON Schema validator (Ajv, for example) checks a body before it leaves your system. If you have a brief rather than an outline, `POST /api/v1/decks/generate` runs Foveate's own outline model against these same rules and builds the deck in one call. ## Error codes | Status | Code | |---|---| | 400 | `invalid_json`, `validation_error`, `invalid_cursor`, `invalid_idempotency_key` | | 401 | `missing_token`, `invalid_api_key`, `invalid_token` | | 402 | `insufficient_credits` | | 403 | `insufficient_scope`, `forbidden` | | 404 | `not_found` | | 409 | `request_in_flight` | | 422 | `empty_deck` | | 429 | `rate_limited` | | 500 | `internal_error` | | 502 / 504 | `generation_*` (provider error / timeout) | --- # Connect Claude Source: https://docs.foveate.com/docs/connect-claude Section: Developers > Let Claude work in your Foveate account — decks, projects, clients, files, sharing, comments and your Studio — with the Foveate connector. The Foveate connector lets [Claude](https://claude.ai) work in your Foveate account while you chat. Ask it to find a deck, draft a new one, move a pursuit to proposal, look up a client, send a share link or read the feedback on a deck. Claude does the work in Foveate and hands you a link to the result. Claude acts **as you**. It sees what you can see, it creates things in your workspace, and anything that uses AI spends your own [credits](https://docs.foveate.com/docs/credits-billing). It only acts while you're asking it to. Nothing runs in the background. ## Connecting The quickest way is the **Connect Claude** button at the top of this page. It opens Claude with the connector's name and address already filled in. Choose **Connect**, then pick up at step 3 below. To add it by hand: 1. In Claude, open **Settings → Connectors** and choose **Add custom connector**. 2. Name it "Foveate" and enter this address: ``` https://app.foveate.com/api/mcp ``` 3. Choose **Connect**. Claude sends you to Foveate. Sign in if you need to. 4. Foveate shows what Claude is asking to do, grouped by area: Decks, Projects, Library, Sharing, Comments, Clients, Studio and AI actions. Review the permissions and choose **Allow**. The connector works in Claude on the web, Claude Desktop and the Claude mobile apps. Once you connect it in one, it's available in all of them. ## Permissions You approve each permission when you connect. A tool that needs a permission you didn't approve replies that the connection needs it, and nothing happens. | Area | Permission | What it allows | |---|---|---| | Decks | See your decks | List your decks and read their names, settings and slides. | | | Create, edit and delete decks | Make new decks from an outline and change or remove the decks you own. | | | Generate decks with AI | Build decks from a prompt. Spends your AI credits. | | Projects | See your projects | List your projects and pursuits and what is filed in them. | | | Create and edit projects | Make new projects and change their details, stage and fee. | | Library | See your library | List the files in your library and read their details. | | Sharing | See share links | See your share links and who has opened them. | | | Share your work | Create share links and send your work by email. | | Comments | See comments | Read the comments and feedback on your decks. | | | Comment on your behalf | Add comments and replies on decks you can see, as you. | | Clients | See the client book | List and read the people your firm works with. | | | Add and update clients | Add people to the client book and edit them. | | Studio | See your Studio | Read your firm profile, team and past proposals. | | AI actions | Run AI actions that spend credits | Ask the in-app assistant, research and enrich clients, and run other AI actions. Spends your AI credits. | ### Adding permissions later As Foveate adds features, a connection you made earlier keeps the permissions you originally approved. **Settings → Developer → Connected apps** lists any permissions Claude hasn't been given. To add them, revoke Claude there, then connect again from Claude's connector settings and approve the new ones. ### Disconnecting Open **Settings → Developer → Connected apps** in Foveate and choose **Revoke**. Claude is disconnected on its next request. You can also remove the connector from Claude's settings. ## Tools These are the tools Claude can use. You don't call them yourself: ask in plain words and Claude chooses the right one. The examples show the kind of request that uses each tool. ### Decks | Tool | What it does | |---|---| | `list_decks` | Lists your decks, newest first. Can be filtered to one project. | | `get_deck` | Opens one deck: its name, project, page size, theme, slide count and links. | | `create_deck` | Builds a deck from an outline Claude writes. **Free.** Foveate lays out every slide; Claude picks each slide's role (cover, content, metrics, timeline and so on) and writes the words. | | `create_deck_from_images` | Builds a deck of your own pictures, one per slide, in the order given. Each picture fills the slide, or sits above a caption if it has one. No cover or closing slide is added. **Free.** | | `generate_deck` | Builds a complete deck from a brief, with Foveate writing the outline. **Spends credits.** Takes up to two minutes. | | `update_deck` | Renames a deck, changes its description or files it in a project. | | `delete_deck` | Permanently deletes a deck you created. **This cannot be undone**, so Claude only uses it when you clearly ask. | | `get_slide` | Opens one slide: its name, speaker notes, background, every piece of text, and every image and object with its position. Claude reads a slide before editing it. | | `edit_slide` | Changes one slide of a deck you made: rewrites its text, renames it, updates its speaker notes, hides or shows it, changes its background colour, moves, resizes or removes things on it, or swaps a picture. Text flowing across linked text boxes, locked items and the master layer are left for you to edit in the app, and Claude tells you so. | | `add_walkthrough_to_deck` | Puts one of your 3D walkthroughs in a deck as a live viewer your audience can explore while you present. By default it gets its own full-screen slide at the end; it can also go elsewhere, or on an existing slide as a live viewer or a preview card. The walkthrough is made viewable to anyone with its link unless you ask Claude to keep it private. | > "Make a 10-slide proposal deck for the Harbor Street library from these notes, and file it in the Harbor Street project." > > "Make a deck of these 19 renders, one per slide, fullscreen." > > "On slide 3 of the Riverside deck, tighten the body copy and update the fee to $1.2M." `create_deck` usually gives the best result: Claude writes the outline from what you've given it, and it costs nothing. Use `generate_deck` when you'd rather Foveate write the outline from a brief. ### 3D walkthroughs | Tool | What it does | |---|---| | `list_walkthroughs` | Lists your 3D walkthroughs (splat scans, 3D models and 360° tours), newest first. Can be filtered by project or kind. | | `get_walkthrough` | Opens one walkthrough: its name, kind, project, whether it's public, its files, its saved views and links to open and share it. | | `create_walkthrough` | Makes a walkthrough from files in your library. One splat file makes a scan, one GLB or GLTF file a 3D model, and one or more images a 360° tour in the order given. **Free.** | | `update_walkthrough` | Renames a walkthrough, changes its description, files it in a project, makes it public or private, or sets the viewer's background colour. Only walkthroughs you created. | | `list_walkthrough_comments` | Lists the comments on a walkthrough, from your team and from guests: which saved view each is on, whether it has a drawing or screenshot, and whether it's resolved. | > "Turn the lobby panoramas in the Harbor Street project into a 360° tour and add it to the end of the Harbor Street deck." ### Projects and pursuits Every project is also a pursuit on your pipeline. | Tool | What it does | |---|---| | `list_projects` | Lists your projects, newest first. Can be filtered by stage, by client or by name. | | `get_project` | Opens one project: client, stage, fee, decision date, team, timeline and deliverables, plus the decks filed in it on request. | | `create_project` | Creates a project, with an optional client, stage, estimated fee and decision date. | | `update_project` | Renames or describes a project, links a client, changes the stage (for example from prospect to proposal, or to won or lost), or sets the fee, decision date or outcome. | > "Which pursuits are at proposal stage with a decision date this month?" > > "We won the Riverside campus job. Mark it won." ### Clients | Tool | What it does | |---|---| | `list_clients` | Lists your client book, newest first, or searches it by name, email or company. | | `get_client` | Opens one person's record: contact details, company, tags and links. | | `create_client` | Adds a person to your client book. If they're already in it, Claude gets back the existing record instead of creating a duplicate. | | `update_client` | Changes a person's details. Claude's edits count as your own, so a CRM sync won't overwrite them. | | `enrich_client` | Looks a client up on the web (LinkedIn, their company's site, press) and fills in what's missing on their record, with a research note. **Spends credits.** | | `research_company` | Finds which architecture, engineering and design firms a client's organisation has worked with, with sources. **Spends credits.** Results are saved for your workspace, so asking again is free unless you ask for a fresh search. | > "Add Dana Whitfield, facilities director at Northgate Health, to the client book, then fill in what you can find about her." ### Files | Tool | What it does | |---|---| | `list_files` | Lists the files in your library (images, video, audio, PDFs, 3D models, drawings and documents), newest first. Can be filtered by type, by project, or by whether you uploaded them or generated them with AI. | | `get_file` | Opens one file's details, with a link to view or download it. | | `open_upload_widget` | Shows an upload panel in the conversation so you can drop files from your computer (renders, photos, PDFs, 3D models) into your library. Claude gets each file's id as it lands and can use it straight away. | | `import_file_from_url` | Brings a file that's already at a web address into your library. Foveate keeps its own copy. Up to 100 MB, not video. | | `upload_file` | Adds a small file Claude has, one it made or one you gave it, to your library in one step. Best under about 1 MB. Not video. | | `start_upload` | Starts an upload of a larger file. Claude either sends it in pieces (up to 50 MB) or, where it can make its own web requests, sends it directly. Video must be sent directly. | | `upload_file_chunk` | Sends one piece of a file being uploaded in pieces. | | `finish_upload` | Joins the pieces of an upload into one file in your library. | | `register_file` | Adds a file to your library after Claude has sent it directly. | > "Find the renderings in the Harbor Street project." > > "I've got a folder of site photos on my laptop. Make a deck of them." You don't need to think about which upload tool Claude uses. When the files are on your computer, Claude opens the upload panel; when they're at a link, it imports them. ### Sharing | Tool | What it does | |---|---| | `create_share` | Gets the share link for a deck, project or 3D walkthrough, or emails it to the people you name with an optional message. Sharing a walkthrough makes it public. | | `get_share` | Shows how a share link is doing: how many times it was opened, the viewers who identified themselves, and recent opens with location. | > "Send the Riverside deck to maria@example.com with a short note, then tell me later whether she opened it." ### Comments | Tool | What it does | |---|---| | `list_comments` | Lists the comments and feedback on a deck, from your team and from guests on the share link. Can be filtered to one slide or to open or resolved comments. | | `add_comment` | Leaves a comment on a slide, or replies to one, as you. The deck's owner is notified. | > "Summarise the client feedback on the Riverside deck and reply to each open comment to say we'll address it in the next revision." ### Notifications | Tool | What it does | |---|---| | `list_notifications` | Reads the same notifications as the bell in Foveate: share links opened and by whom, new comments and mentions, access requests, projects you were added to, form responses and viewer questions. Can show only unread ones, one kind, or everything since a given time. Reading them in Claude doesn't mark them as read in Foveate. | > "What did I miss today? Has anyone opened the Harbor deck?" ### Studio These tools let Claude write in your firm's voice and reuse your past work. | Tool | What it does | |---|---| | `get_firm_profile` | Reads your firm profile: what you're trying to win (sectors, places, named accounts, project size), what you turn down and who you compete with. | | `list_studio_people` | Lists your team as presented in proposals: names, titles and bios. | | `list_past_proposals` | Lists your past proposal submissions: title, client, year, location, outcome and sections. | | `get_past_proposal` | Opens one past proposal in full, section by section. Fee sections are marked so Claude treats them with care. | > "Draft a project approach for the Harbor Street library, using our firm profile and the approach from our best past library proposal." ### The assistant | Tool | What it does | |---|---| | `ask_foveate` | Hands a request to the assistant you have in the Foveate app and returns its reply. **Spends credits** at the surface's rate. | Claude picks a surface for the request: | Surface | What it does | Works on | |---|---|---| | `workspace` | Your whole workspace: looks things up, creates decks, projects, forms and clients, answers questions about the pipeline. | — | | `research` | Cited answers over RFP documents Claude passes as sources (the RFP first), or over a project's research documents. | A project, optional | | `form-editor` | Edits a form: adds, changes, moves and removes questions. | A form | | `client-profile` | Writes the client's psychological and deal profile onto their record. | A client | Claude can also give the assistant context your team already knows, which it uses but never cites, and can let it search the live web for that turn. The reply comes back with any artifacts the assistant produced, the credits spent, and a thread id. Claude keeps that id to continue the conversation, and Foveate keeps the transcript. > "Ask Foveate what's due this week across my pursuits, then draft the Riverside intake form from the RFP I pasted." ### Account | Tool | What it does | |---|---| | `whoami` | Shows which Foveate account the connection uses and which permissions it has. Useful when something isn't working. | | `get_job` | Checks on a longer task that runs in the background. Claude uses this on its own when a task needs it. | ## Prompts The connector offers five of Foveate's built-in skills as prompts you can pick in Claude. Each takes a few typed arguments and is a recipe that uses the tools above. | Prompt | Name | What it does | |---|---|---| | Decks and Proposals | `proposal_deck` | Builds a client-ready proposal or pitch deck from a brief. | | Design Sales Rooms | `brand_sales_room` | A shareable buyer space: a deck themed to the client's brand, shared as a link. | | Research an RFP | `research_rfp` | Reads an RFP package and answers grounded questions about it, with citations. | | Client intake quiz | `client_intake_form` | A project brief and design-personality questionnaire, as a Foveate form. | | Client profiler | `client_profile` | Researches a prospect and builds their psychological and deal profile in the client book. | ## Resources The connector exposes one resource. `foveate://threads/{threadId}/sources` returns the documents attached to one of your chat threads, the RFP and its addenda, as numbered source blocks ready to cite. Only the thread's owner can read it, and it needs the **See your library** permission. ## Credits Most tools are free. These spend your AI credits, exactly as the same action does in the app: - `ask_foveate` - `generate_deck` - `enrich_client` - `research_company` Every result that spends credits reports what it cost. If your balance is too low, the tool says so and nothing is charged. See [Credits & billing](https://docs.foveate.com/docs/credits-billing). ## Tips - **Links come back with everything.** Decks, projects and share links include a link you can open in Foveate, so you can check Claude's work. - **Asking twice won't duplicate anything.** If Claude repeats a request, for example after a dropped connection, you get back the deck, project, comment or client from the first time rather than a second copy. - **Start with `whoami` if something fails.** It shows whether the connection is working and which permissions it has. A message saying the connection "needs" a permission means you need to reconnect and approve it (see [Adding permissions later](#adding-permissions-later)). - **Using ChatGPT or Codex instead?** The same connector works there. See [Connect ChatGPT & Codex](https://docs.foveate.com/docs/connect-chatgpt). - **Building your own integration?** The same features are available to your own tools through the [API](https://docs.foveate.com/docs/api). --- # Connect ChatGPT & Codex Source: https://docs.foveate.com/docs/connect-chatgpt Section: Developers > Use Foveate from ChatGPT and from Codex — decks, projects, clients, files, sharing, comments and your Studio — through the same connector Claude uses. Foveate's connector is a standard remote MCP server, so it works in [ChatGPT](https://chatgpt.com) and in OpenAI's [Codex](https://chatgpt.com/codex) as well as in Claude. Ask ChatGPT to find a deck, draft a new one, move a pursuit to proposal or read the feedback on a share link. Point Codex at it and your coding agent can file decks, look up clients and pull your firm profile while it works. Both act **as you**. They see what you can see, create things in your workspace, and anything that uses AI spends your own [credits](https://docs.foveate.com/docs/credits-billing). They only act while you're asking. Nothing runs in the background. The connector's address is the same everywhere: ``` https://app.foveate.com/api/mcp ``` ## Connecting ChatGPT Custom connectors in ChatGPT need **Developer mode**, which is available on the Pro, Team, Enterprise and Edu plans. 1. In ChatGPT, open **Settings → Apps & Connectors → Advanced settings** and turn on **Developer mode**. OpenAI has moved this toggle before. If it isn't there, look under **Settings → Security**. 2. Back in **Apps & Connectors**, choose **Create**. 3. Name it "Foveate", paste the address above into the **MCP server URL** field, and set **Authentication** to **OAuth**. Tick **I trust this application** and choose **Create**. 4. ChatGPT sends you to Foveate. Sign in if you need to, review the permissions grouped by area, and choose **Allow**. To use it in a chat, open the **+** menu in the composer, pick Foveate under connectors, and ask in plain words. ## Connecting Codex Codex reads MCP servers from one config file, so a server added in the CLI is also available in the Codex IDE extension and the Codex desktop app. The quickest way is the **Use in Codex** button at the top of this page. It copies the command below. Paste it into a terminal, then sign in: ```bash codex mcp add foveate --url https://app.foveate.com/api/mcp codex mcp login foveate ``` The second command opens Foveate in your browser to approve the connection, then returns to the terminal. If you'd rather edit the config yourself, add this to `~/.codex/config.toml` and run `codex mcp login foveate`: ```toml [mcp_servers.foveate] url = "https://app.foveate.com/api/mcp" ``` In the IDE extension or desktop app you can also open **Settings → MCP servers**, choose **Add server**, pick **Streamable HTTP**, and paste the address. ## Permissions You approve permissions once, when you first connect. They are the same ones Claude asks for, grouped by area: Decks, Projects, Library, Sharing, Comments, Clients, Studio and AI actions. The full table, with what each permission allows, is on [Connect Claude](https://docs.foveate.com/docs/connect-claude#permissions). A tool that needs a permission you didn't approve replies that the connection needs it, and nothing happens. To add permissions later, or to disconnect, open **Settings → Developer → Connected apps** in Foveate. Revoking there disconnects the app on its next request, and you can connect again to approve a new set. ## What you can do ChatGPT and Codex get the same tools as Claude. You don't call them yourself: ask in plain words and the assistant chooses. - **Decks.** List and open your decks, build one from an outline (free), generate one from a brief (spends credits), rename or file it, and delete it when you clearly ask. - **Projects and pursuits.** List projects by stage or client, open one with its fee, decision date and deliverables, create and update them, and move a pursuit through the pipeline. - **Clients.** Search the client book, add and update people, and research or enrich a client from the web (spends credits). - **Files.** Find images, video, PDFs, 3D models and documents in your library, filtered by type or project. - **Sharing and comments.** Get or email a share link, see who opened it, read the feedback on a deck and reply as you. - **Studio.** Read your firm profile, team bios and past proposals so the assistant writes in your firm's voice. - **The assistant.** Hand a request to the assistant inside the Foveate app and continue the conversation by thread (spends credits). The complete tool list, with an example request for each, is on [Connect Claude](https://docs.foveate.com/docs/connect-claude#tools). ## Credits Most tools are free. These spend your AI credits, exactly as the same action does in the app: - `ask_foveate` - `generate_deck` - `enrich_client` - `research_company` Every result that spends credits reports what it cost. If your balance is too low, the tool says so and nothing is charged. See [Credits & billing](https://docs.foveate.com/docs/credits-billing). ## Tips - **Links come back with everything.** Decks, projects and share links include a link you can open in Foveate, so you can check the work. - **Asking twice won't duplicate anything.** A repeated request, for example after a dropped connection, returns the deck, project, comment or client from the first time rather than a second copy. - **Start with `whoami` if something fails.** It shows which Foveate account the connection uses and which permissions it has. In Codex, `codex mcp list` shows whether the server is configured and signed in. - **Building your own integration?** The same features are available to your own tools through the [API](https://docs.foveate.com/docs/api).