OpenAPI and clients
Download the contract and generate TypeScript or Python clients.
The checked OpenAPI 3.1 contract drives the API reference and client generation. It is the best integration starting point for typed projects.
Download the contract
The reference displays request builders and code examples, but live browser execution is disabled while only production-style keys exist. Run requests from your backend or terminal.
Generate a TypeScript client
The following command generates Fetch-based TypeScript types and SDK functions with the pinned generator used by our CI:
npx --yes \
--package [email protected] \
--package @hey-api/[email protected] \
openapi-ts \
--input https://www.pravenintelekt.com/openapi/public-v1.json \
--output src/praven-intelekt-apiConfigure the generated client's base URL and API-key header in one place. Do not expose the generated client from a browser bundle when it contains a live key.
Generate a Python client
Install the generator in an isolated environment, then generate from the public contract:
pipx run --spec openapi-python-client==0.29.0 \
openapi-python-client generate \
--url https://www.pravenintelekt.com/openapi/public-v1.jsonThe output includes sync and async httpx clients, typed models, and endpoint modules grouped by OpenAPI tag.
Repository workflow
Contributors to Praven Intelekt can generate both clients with one command:
scripts/generate_public_api_clients.shThe output lands in the ignored generated-clients/ directory. CI regenerates both languages on every contract change and fails if the checked OpenAPI document has drifted from the FastAPI router.
Compatibility policy
Generated code is not committed or published as an official package during private beta. Pin the contract version or generated output in your application and review diffs before upgrading. Official versioned packages will be published after the API's beta reliability and release process are complete.