OpenAPI Specification

The inSigner Cloud API provides a machine-readable OpenAPI 3.1 specification. Use it to generate client libraries, validate requests, or import into API tools.

Download

https://app.insigner.co/api/v1/openapi

Available formats:

Format	URL
JSON	`https://app.insigner.co/api/v1/openapi?format=json`
YAML	`https://app.insigner.co/api/v1/openapi?format=yaml`

Code generation

Generate a TypeScript client

npx openapi-typescript https://app.insigner.co/api/v1/openapi -o ./src/api/insigner.ts

Generate a Python client

pip install openapi-python-client
openapi-python-client generate --url https://app.insigner.co/api/v1/openapi

Generate with OpenAPI Generator

npx @openapitools/openapi-generator-cli generate \
  -i https://app.insigner.co/api/v1/openapi \
  -g typescript-fetch \
  -o ./src/api/insigner

Using with tools

Swagger UI

Load the spec in Swagger UI to explore the API visually:

docker run -p 8080:8080 \
  -e SWAGGER_JSON_URL=https://app.insigner.co/api/v1/openapi \
  swaggerapi/swagger-ui

VS Code

Install the OpenAPI (Swagger) Editor extension, then open the spec file for inline documentation, auto-completion, and validation.

Insomnia / Bruno

Both Insomnia and Bruno can import OpenAPI specs directly:

Open Import dialog
Select URL or File
Paste https://app.insigner.co/api/v1/openapi
All endpoints are imported with pre-filled parameters