Resources / API spec & tools

API spec & tools

There's no SDK to install yet. The API is plain REST over HTTPS, so any HTTP client works. For typed clients and tooling, use the OpenAPI spec.

OpenAPI 3.1 spec

A machine-readable description of every endpoint, kept in sync with the API.

GET /v1/openapi

Postman

Import the spec URL into Postman to get a ready-made request collection.

Import → Link → spec URL

Download the spec

The spec lives at /v1/openapi and needs no API key. Save it, or point a tool straight at the URL.

Terminal

curl https://app.converly.io/api/v1/openapi -o converly-openapi.json

Use the spec with any OpenAPI generator to scaffold a typed client in your language of choice.

Terminal

npx @openapitools/openapi-generator-cli generate \
  -i https://app.converly.io/api/v1/openapi \
  -g typescript-fetch \
  -o ./converly-client