OpenAPI & SDK generation

Forvibe ships an OpenAPI 3.1 document for the Public API v1 at:

bash

https://forvibe.app/api/v1/openapi.json
https://forvibe.app/api/v1/swagger.json    # alias

It's static, unauthenticated, and cached at the edge for one day. Import it into the tools you already use.

Postman

File → Import → paste the URL. Postman generates a collection mirroring every endpoint; add your bearer token in the collection auth settings.

Stoplight Studio / Redoc

Paste the URL or upload the JSON. Stoplight renders the full reference and lets you try requests interactively.

TypeScript SDK with openapi-fetch

bash

# 1. Install
npm install openapi-fetch
npm install -D openapi-typescript

# 2. Generate types
npx openapi-typescript https://forvibe.app/api/v1/openapi.json -o forvibe.d.ts

# 3. Use
cat <<'EOF' > forvibe.ts
import createClient from "openapi-fetch";
import type { paths } from "./forvibe";

export const client = createClient<paths>({
  baseUrl: "https://forvibe.app/api/v1",
  headers: { Authorization: `Bearer ${process.env.FVK_API_KEY}` },
});
EOF

Python SDK with openapi-python-client

bash

pipx install openapi-python-client
openapi-python-client generate --url https://forvibe.app/api/v1/openapi.json