Developer Platform

Build This API recipes

Eighteen complete, contract-backed API slices for BuildWithHQ and API43 product concepts.

These recipes turn each Build This concept into an ordered API slice. Every method, path, scope, parameter, request schema, response status, and SDK method is generated from the current public contract. The support page cannot quietly drift from OpenAPI: the recipe generator and Developer Kit build fail when an operation disappears or changes.

How to use a recipe

1. Choose the product slice and grant a backend credential only its listed scopes.
2. Use real identifiers returned by prior steps or selected from real app configuration; the recipes contain no sample GUIDs.
3. Use the app credential only for account and user administration. Exchange it for a short-lived user token before performing end-user work.
4. Resolve each step's request body from the named OpenAPI schema. Generated clients receive the same shape.
5. Carry correlation IDs end to end and run all four release assertions.

A credential missing a listed scope must receive HTTP 403 with credential_scope_required. A delegated user outside the record envelope must receive the module's non-disclosing 403/404 response, and no mutation may occur.

import { BuildWithHQModuleClient } from "./sdk/BuildWithHQConnector.js";

const api = new BuildWithHQModuleClient({
  saasAppId: process.env.BWHQ_SAAS_APP_ID!,
  credential: delegatedUserToken,
});

// Choose the exact typed method listed below. Values come from the signed-in
// user's permitted selection or a prior response, never from a sample tenant.
const result = await api.workOrdersGet({ recordId });