Generations

Overview

The Generations endpoints start a documentation generation for a project, follow its progress, and manage its results. A generation is one run of Doxabot against the project's connected GitHub repository. It writes MDX pages and stores them as a versioned artifact. Publishing happens separately, by switching the active docs version.

Every endpoint in this group is scoped to a project. Pass the project ID in the path as projectId, and pass the generation ID as generationId where a single generation is addressed. The same operations are available in the dashboard on the project's Generations page, and to connected agents through the generation:run scope. See Generations and Doxabot Instructions for the dashboard workflow.

Starting a generation requires permission to run generations on the project. The project owner's account is charged for the run.

Use the list and stream endpoints to watch progress. The events endpoint returns the events recorded for one generation. The stream endpoint pushes the same kind of updates as server-sent events, and it accepts a cursor so a client can resume from the last event it received.

Schema

The request and response bodies use the generation DTOs from the shared contracts package. The table lists the fields that the endpoints in this group take as input.

Generation responses return a generation object, or a list of them. Starting a generation returns a start result that describes whether the run began. Event responses return the events recorded for one generation, in the order they were recorded.

Endpoints