Weave API

Base URL https://api.ipweave.com. JSON in, JSON out. Bearer authentication. Rate limits apply per account (generous for interactive use; talk to us if you are automating heavily).

Endpoints

Method	Path	Purpose
POST	/auth/register	Create an account (email verification required)
POST	/auth/jwt/login	Obtain a bearer token
GET	/auth/github/authorize	GitHub OAuth sign-in
GET	/catalog	List components: VLNV, interfaces, params, registers
GET	/catalog/{vlnv}	Full detail for one component
POST	/weave	Elaborate a design; returns the report; stores your config
GET	/weave/requests	Your stored weave configurations
GET	/me	Account, tier and profile

The design format

A design is YAML: a top name and a map of instances, each naming a catalogue VLNV. Connections and parameter overrides follow the same shape as the underlying weft elaborator. Library paths are always managed server-side — a design only ever names VLNVs, never filesystem paths.

top: my_soc
instances:
  bar:  { vlnv: "ipweave:ip:xbar_axil:1.0" }
  uart: { vlnv: "ipweave:ip:uart_axil:1.0" }
  dma:  { vlnv: "ipweave:ip:axi_dma:1.0" }

What you get back

• ok — whether elaboration succeeded
• vlnvs / instance_count / ports — what was resolved and produced
• warnings — every unconnected input and elaboration note, explicitly
• error — a precise message when something cannot elaborate

Access tiers

Standard accounts access the whole current catalogue for free. A restricted tier exists for future export-controlled cores (e.g. post-quantum crypto); it is granted per-organisation on request — contact us if that applies to you.