# Avocado Studio

## Docs

- [Get authstatus](https://docs.avocadostudio.dev/api-reference/get-authstatus.md)
- [Get chatstream](https://docs.avocadostudio.dev/api-reference/get-chatstream.md)
- [Get docsjson](https://docs.avocadostudio.dev/api-reference/get-docsjson.md)
- [Get draftpages](https://docs.avocadostudio.dev/api-reference/get-draftpages.md)
- [Get draftsite config](https://docs.avocadostudio.dev/api-reference/get-draftsite-config.md)
- [Get draftslugs](https://docs.avocadostudio.dev/api-reference/get-draftslugs.md)
- [Get health](https://docs.avocadostudio.dev/api-reference/get-health.md)
- [Get historylog](https://docs.avocadostudio.dev/api-reference/get-historylog.md)
- [Get historystatus](https://docs.avocadostudio.dev/api-reference/get-historystatus.md)
- [Get publishcontent](https://docs.avocadostudio.dev/api-reference/get-publishcontent.md)
- [Get publishstatus](https://docs.avocadostudio.dev/api-reference/get-publishstatus.md)
- [Get sites](https://docs.avocadostudio.dev/api-reference/get-sites.md)
- [Get sites agentstream](https://docs.avocadostudio.dev/api-reference/get-sites-agentstream.md)
- [Get unsplashsearch](https://docs.avocadostudio.dev/api-reference/get-unsplashsearch.md)
- [API Reference](https://docs.avocadostudio.dev/api-reference/index.md): OpenAPI 3.0 reference for the orchestrator's HTTP API. Auto-generated from the running Fastify routes — currently a skeleton without request/response schemas (placeholder spec, see notes below).
- [Post authverify](https://docs.avocadostudio.dev/api-reference/post-authverify.md)
- [Post chat](https://docs.avocadostudio.dev/api-reference/post-chat.md)
- [Post chatcancel](https://docs.avocadostudio.dev/api-reference/post-chatcancel.md)
- [Post chatprefetch](https://docs.avocadostudio.dev/api-reference/post-chatprefetch.md)
- [Post chatstart](https://docs.avocadostudio.dev/api-reference/post-chatstart.md)
- [Post chatvariations](https://docs.avocadostudio.dev/api-reference/post-chatvariations.md)
- [Post draftbootstrap](https://docs.avocadostudio.dev/api-reference/post-draftbootstrap.md)
- [Post historyredo](https://docs.avocadostudio.dev/api-reference/post-historyredo.md)
- [Post historyrestore](https://docs.avocadostudio.dev/api-reference/post-historyrestore.md)
- [Post historyundo](https://docs.avocadostudio.dev/api-reference/post-historyundo.md)
- [Post imagegenerate](https://docs.avocadostudio.dev/api-reference/post-imagegenerate.md)
- [Post imagegeneratechat](https://docs.avocadostudio.dev/api-reference/post-imagegeneratechat.md)
- [Post imageinterpret](https://docs.avocadostudio.dev/api-reference/post-imageinterpret.md)
- [Post imageupload](https://docs.avocadostudio.dev/api-reference/post-imageupload.md)
- [Post ops](https://docs.avocadostudio.dev/api-reference/post-ops.md)
- [Post publish](https://docs.avocadostudio.dev/api-reference/post-publish.md)
- [Post sites agentcancel](https://docs.avocadostudio.dev/api-reference/post-sites-agentcancel.md)
- [Post sites agentrespond](https://docs.avocadostudio.dev/api-reference/post-sites-agentrespond.md)
- [Post sites agentstart](https://docs.avocadostudio.dev/api-reference/post-sites-agentstart.md)
- [Post sitesregister](https://docs.avocadostudio.dev/api-reference/post-sitesregister.md)
- [Put draftsite config](https://docs.avocadostudio.dev/api-reference/put-draftsite-config.md)
- [Architecture](https://docs.avocadostudio.dev/architecture.md): How the three services, packages, and data flow fit together.
- [Core Concepts](https://docs.avocadostudio.dev/concepts.md): Key terms and mental model for understanding Avocado Studio.
- [Asset Manager & AI Images](https://docs.avocadostudio.dev/features/asset-picker.md): Image sources, AI generation with OpenAI and Gemini (nano-banana), multi-turn image chat, and how the editor and chat pipeline resolve images.
- [Immersive Mode](https://docs.avocadostudio.dev/features/immersive-mode.md): Edit directly on the live-feeling site. How to enter from the main editor, what the widget offers, and how to return.
- [Variants (Block Alternatives)](https://docs.avocadostudio.dev/features/variants.md): Generate multiple AI-authored alternatives for a single block — different tones, copy directions, and images — then pick one to apply. Two entry paths: the REST variation pipeline and the agent's generate_variations tool.
- [Guardrail Schema Concept](https://docs.avocadostudio.dev/guardrails/guardrail-schema-concept.md): Defines a schema contract that constrains AI-generated edits for predictable, valid results.
- [v1 Implementation Checklist](https://docs.avocadostudio.dev/guardrails/guardrail-schema-v1-implementation-checklist.md): Step-by-step checklist for implementing Guardrail Schema v1 in the orchestrator.
- [v1 Specification](https://docs.avocadostudio.dev/guardrails/guardrail-schema-v1-spec.md): Full specification for guardrails on AI-generated edits in the current architecture.
- [How It Works](https://docs.avocadostudio.dev/how-it-works.md): Step-by-step walkthrough of the editing pipeline — from user message to live preview update.
- [Avocado Studio](https://docs.avocadostudio.dev/index.md): Open, agentic, composable content operations. A modern AI-native content layer that brings agentic editing — the kind enterprise content platforms are now investing heavily in — to teams who can't or don't want to take on a six-figure platform contract.
- [Block System Architecture](https://docs.avocadostudio.dev/integration/block-system.md): How block schemas and renderers are organized, connected, and used across the stack — from definition to AI planning to rendering.
- [Custom Blocks](https://docs.avocadostudio.dev/integration/custom-blocks.md): Register your own block types with custom schemas, renderers, and props — the AI planner picks them up automatically.
- [Editor Quickstart](https://docs.avocadostudio.dev/integration/editor-quickstart.md): Env vars, iframe bootstrap URL pattern, and smoke checks for the editor's connection to a Next.js site in embedded Draft Mode.
- [Integration Overview](https://docs.avocadostudio.dev/integration/index.md): Entry point for adding AI editing to your site. Next.js 15 (App Router) is the only officially supported path today; other frameworks are first-mover territory.
- [Jira Integration](https://docs.avocadostudio.dev/integration/jira.md): Let Avocado Studio act on Jira tickets: review, apply edits, and publish via webhook or polling.
- [MCP Server](https://docs.avocadostudio.dev/integration/mcp-server.md): Drive Avocado Studio from Claude Desktop, Claude Code, or any Model Context Protocol host.
- [Next.js Integration](https://docs.avocadostudio.dev/integration/nextjs-integration.md): Canonical onboarding path for any Next.js 15 site — two SDK helpers, one catch-all editor route, edit through Draft Mode without a /preview route.
- [Non-Next.js Integration](https://docs.avocadostudio.dev/integration/non-nextjs.md): How to implement the editor API contract on Astro, Remix, SvelteKit, Hono, or any framework that exposes web-standard Request/Response handlers — using the SDK's framework-agnostic /core primitives.
- [Puck Mode](https://docs.avocadostudio.dev/integration/puck-mode.md): Enable a visual drag-and-drop editing experience alongside AI chat using the Puck editor.
- [Native Tools](https://docs.avocadostudio.dev/integration/tools-mvp.md): Tool contract and onboarding flow for connecting external services (PIM, DAM, search, AI image generation) to the AI planner.
- [Chat Telemetry Events](https://docs.avocadostudio.dev/observability/chat-telemetry-events.md): Reference for all telemetry events emitted by the orchestrator chat pipeline.
- [Chat Troubleshooting](https://docs.avocadostudio.dev/observability/chat-troubleshooting.md): Playbook for investigating prompt failures, wrong operations, and regressions in the chat assistant.
- [End-to-End Tracing](https://docs.avocadostudio.dev/observability/e2e-tracing.md): Plan for end-to-end correlation and observability across the editing pipeline.
- [Token Usage Tracking](https://docs.avocadostudio.dev/observability/token-usage-tracking.md): How the orchestrator tracks LLM token usage and estimated cost across debug panel, logs, and telemetry.
- [Dev Server Runbook](https://docs.avocadostudio.dev/operations/dev-server-runbook.md): Runbook for running and troubleshooting the three local development services.
- [Docker Deployment](https://docs.avocadostudio.dev/operations/docker-deployment.md): Deploy the orchestrator as a self-contained Docker image. The orchestrator is the one part of Avocado Studio that isn't open source today — Docker is the supported self-hosting path.
- [Deploy to Netlify](https://docs.avocadostudio.dev/operations/netlify-deployment.md): Deploy Avocado Studio site and Content Studio to Netlify.
- [Streaming Patch Checklist](https://docs.avocadostudio.dev/operations/streaming-patch-checklist.md): Task checklist for implementing optimistic streaming patch transport in the editor and orchestrator.
- [Vercel Deployment](https://docs.avocadostudio.dev/operations/vercel-deployment.md): Guide for deploying Avocado Studio to Vercel.
- [Bring Your Own Coding Agent](https://docs.avocadostudio.dev/sites/coding-agent.md): Hand the integration to your own coding agent — Codex, Claude Code, Cursor, Aider, or anything that can read files and run commands. We provide the prompt, the agent does the work.
- [Add a Site](https://docs.avocadostudio.dev/sites/index.md): Two ways to bring a website into Avocado Studio: let our Onboarding agent do it for you, or code it yourself (by hand or with your own coding agent). Currently supports Next.js.
- [Manual Integration](https://docs.avocadostudio.dev/sites/manual.md): Add a site to Avocado Studio by hand — no AI, full control. Same end state as the Onboarding agent, every line of code is yours.
- [Onboarding agent](https://docs.avocadostudio.dev/sites/site-agent.md): The AI agent built into the editor that brings sites into Avocado Studio. How to use it, what you need before you start, and how it runs under the hood.
- [Architecture & API Reference](https://docs.avocadostudio.dev/specs/ai-website-editor-poc-spec.md): Detailed product architecture, domain model, API surface, and technical specifications.
- [Block Schema Contracts](https://docs.avocadostudio.dev/specs/block-schema-contracts.md): How block schemas are described to the LLM planner, how contracts are assembled, and why we use prop-list contracts instead of JSON Schema.
- [Transformation Runbook](https://docs.avocadostudio.dev/testing/avocado-transformation-demo-runbook.md): Step-by-step runbook for the Avocado Stories transformation walkthrough aimed at product stakeholders.
- [E2E Editing Prompts](https://docs.avocadostudio.dev/testing/e2e-editing-prompts.md): Catalog of end-to-end editing prompts used in the task-solving test suite.

## OpenAPI Specs

- [orchestrator.openapi](https://docs.avocadostudio.dev/api-reference/orchestrator.openapi.json)
- [openapi](https://docs.avocadostudio.dev/api-reference/openapi.json)