OpenAPI specification

The full Sigil HTTP API is described as an OpenAPI 3.1 specification. Pipe it into your favourite client generator, import it into Postman / Insomnia / Bruno, or browse it interactively.

Open the interactive reference Full-screen Scalar viewer with try-it-out, schema browsing and search.

openapi.yaml

Download YAML

openapi.json

Download JSON

Generate clients

OpenAPI Generator covers most languages:

# Go
openapi-generator-cli generate -i https://developers.sigilkeys.com/openapi.yaml \
  -g go -o ./sigil-go-client

# TypeScript fetch
openapi-generator-cli generate -i https://developers.sigilkeys.com/openapi.yaml \
  -g typescript-fetch -o ./sigil-ts-client

# Python
openapi-generator-cli generate -i https://developers.sigilkeys.com/openapi.yaml \
  -g python -o ./sigil-python-client

For the wallet (iframe) lane, you almost certainly want @sigilkeys/sdk instead of a generated client — the SDK takes care of the iframe lifecycle, the postMessage handshake and the secure share reconstruction.