Getting started

The platform is an HTTP API at api.ipweave.com. Everything below works from curl; SDKs and the web console are on the way.

1. Create an account

Register with an email and password (or use GitHub sign-in from the site). You'll receive a verification email — protected endpoints require a verified address.

curl -X POST https://api.ipweave.com/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"…"}'

2. Sign in, get a token

curl -X POST https://api.ipweave.com/auth/jwt/login \
  -d "username=you@example.com" -d "password=…"
# → {"access_token":"…","token_type":"bearer"}

3. Browse the catalogue

213 components with interfaces, parameter counts and register maps as structured data.

curl https://api.ipweave.com/catalog?limit=5 \
  -H "Authorization: Bearer $TOKEN"

4. Weave a design

A design is a small YAML document naming component VLNVs and, as you go further, the connections between them. The platform elaborates it and returns a full report.

curl -X POST https://api.ipweave.com/weave \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"first","design_yaml":"top: t\ninstances:\n  f0: {vlnv: \"ipweave:ip:axis_fifo:1.0\"}\n"}'
# → ok: true · top: t · 1 instance · elaboration warnings listed

Your submitted configurations are stored so you can revisit them; see the full API reference for the design format, rate limits and access tiers.