OpenAPI 3.1
openapi.json describes every route below for API version 2026-09-15. Load it into any OpenAPI tool. Base URL, authentication, scopes, error codes and the rate limit are in the document.
Akwa Platform · API reference
The OpenAPI 3.1 document is generated from the router that serves the API, and a test fails the build if the two disagree. Read it below, or load it into any OpenAPI tool.
openapi.json describes every route below for API version 2026-09-15. Load it into any OpenAPI tool. Base URL, authentication, scopes, error codes and the rate limit are in the document.
| Method | Path | Scope | What it returns |
|---|---|---|---|
GET | /v1 | none | Route list, documentation URL and the authentication hint. |
GET | /v1/me | read | Who this credential is: user id, plan, scopes. |
GET | /v1/designs | read | Your designs, newest first (limit, before). |
GET | /v1/designs/{designId}/graph | read | Profile-filtered garment graph (profile=technical_designer|factory). |
GET | /v1/designs/{designId}/tailor-brief | read | The derived tailor brief. |
GET | /v1/designs/{designId}/design-trust | read | Design Trust provenance aggregate. |
GET | /v1/designs/{designId}/confirmations | read | Values that still need a human decision. |
GET | /v1/garments/{garmentId}/{resource} | read | The same four reads by permanent garment identity (AKW-n), including published Akwa house garments, which carry facts with epistemic states. |
POST | /v1/designs/{designId}/exports | export | Governed export (illustrator_svg_stage1 | json), one-hour download link. |
POST | /v1/designs/{designId}/tech-packs | generate | Request a Tech Pack. Returns 202 composing (included in your plan) or 402 with a checkout link. |
GET | /v1/tech-packs/{purchaseId} | read | Tech Pack status and, when delivered, a one-hour PDF link. |
| Tool | Read-only | What it returns |
|---|---|---|
get_garment_graph | yes | The garment graph for a design you own or a published house garment (AKW-n), profile-filtered. |
get_tailor_brief | yes | The derived tailor brief. |
run_design_trust | yes | Design Trust provenance aggregate, derived from the pack's own rows; no score, no verdict. |
list_unresolved_confirmations | yes | Values awaiting a human decision. |
export_design | no, writes an export row | A layered SVG for Illustrator, or JSON; writes an export row; one-hour link. |
Renders and imagery are never returned by any route or tool.
Claude and Claude Code are trade marks of Anthropic, PBC. ChatGPT is a trade mark of OpenAI. Visual Studio Code and GitHub Copilot are trade marks of Microsoft Corporation. Adobe and Illustrator are trade marks of Adobe Inc. Akwa is not affiliated with, endorsed by or sponsored by any of them. Names are used only to identify the tools a key connects to.