Skip to main content
Fast and Deep Spec share the same REST input fields and output formats. The OpenAPI schema defines their machine-readable shapes.

​
Describe a project or a change

currentContext is text, not a project lookup ID. Include the relevant context explicitly. The MCP equivalents are executiveSummary and existingContext; see the field mapping.

​
Upload a file

Use multipart/form-data with one file. Supply the file, input text, or both. Accepted formats are PDF, DOC, DOCX, TXT, JPEG, and PNG, up to 20 MiB (20 × 1,024 × 1,024 bytes).
In multipart requests, encode docURLs as a JSON string and async as true or false text. Let your HTTP library set the multipart boundary. The file part must carry an accepted MIME type; renaming an unsupported file is not sufficient. The response may include uploadedFileName and uploadedFileShortUrl. File upload is a REST feature; MCP specification tools do not accept a file argument.

​
Choose the output for your reader

Request spec status for full bodies. List and search return summaries and links, not full specification bodies or graphs.

​
Graphs and visual artifacts

userFlowGraph and architectureGraph each contain nodes and edges. Use node id values to resolve an edge’s source and target.
In this example, the web app sends HTTPS requests to the API. The edge points from the node named by source to the node named by target: Node level can be a number, a string, or null: user-flow graphs can use numeric depth, while architecture graphs use levels such as C1 and C2. architectureInfographicUrl is an optional rendered diagram. enrichedTechStack explains technology choices, uses, alternatives, and helpful links.

​
Documentation archives

When reference documentation can be retrieved, zippedDocsUrls contains entries with platform, masterZipShortUrl, and masterMarkdownShortUrl. Archive generation is best effort; archives may be absent or empty even when the specification succeeds. Use the source documentation for details that need current verification.

​
Optional fields

The returned fields depend on generation progress and available artifacts. Optional outputs may be absent or null; check them before rendering or downloading. Use status for lifecycle decisions, progressMessage for display, and creditsUsed for observed credit usage.