Get the five documents the Product's current Core generates

product.documents

Returns the Business, Technical, Security, Infrastructure and Tests documents for the Product's current Build, each a standalone HTML page that prints on A4. They are derived from the Build's compiled UDL, its checks and its program source, so they cannot drift from what the Core runs: the same Build always returns the same bytes, and each document carries the SHA-256 of its HTML.

GET /v1/products/{productId}/documents

Principal api_key. Idempotency not_required. Environment either.

Input

Request sample

curl

curl --request GET 'https://hyperscale0.ai/v1/products/prd_sandbox_example0001/documents' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox'

TypeScript SDK

import { createClient } from "@hyperscale0/sdk";

const hs = createClient({
  apiKey: process.env.HYPERSCALE_API_KEY,
  productId: process.env.HYPERSCALE_PRODUCT_ID,
});
const result = await hs.call("product.documents");

CLI

hyperscale api call product.documents

Errors

All operations