weft Request access

Docs

Build against the live schema.

Every example below runs against the public beta. Copy it, run it, check the response.

Quickstart

Install the CLI, point it at your spec and deploy. The output tells you where the API lives.

npm i -g @weft/cli
weft init --from openapi.yaml
weft deploy --env production

Authentication

Send a key in the Authorization header. Keys are scoped to one environment. Create a key under Settings on the dashboard, then store it in your secret manager, not in source.

curl https://api.example.com/v1/orders \
  -H "Authorization: Bearer $WEFT_KEY"

Typed clients

Each deploy writes an SDK that matches the schema it runs. Run weft sdk --check in CI. It fails the build when the committed client is out of date.

Webhooks

Weft signs each webhook with an HMAC of the raw body. Verify the signature before you parse the JSON. Failed deliveries retry for 24 hours with backoff.

Rate limits

Each response includes RateLimit-Remaining and RateLimit-Reset. When a limit is hit you get a 429 with Retry-After in seconds. Back off for that long.

Need more than the quickstart?

Request beta access