Versions and environments
v1 is the only documented API version; choose the agreed environment explicitly.
API major versions
All public operations in this documentation use /v1. The version selector contains only this real contract. The docs application and documentation framework have their own package versions; those do not change the API version.
Treat a future major version as a separate contract. Check the changelog and generated OpenAPI download when updating an integration. No v2 release or deprecation date has been announced here.
Environments
Production documentation is intended for docs.bioparse.co. Staging documentation uses staging.docs.bioparse.co and requires access credentials. Those documentation credentials are distinct from your clinic API Bearer token.
Coordinate the actual API origin and clinic access with BioParse. These guides use https://api.example.invalid so illustrative commands cannot accidentally query clinical data. There is no public synthetic sandbox in this release.
Production API keys use bp_live_; nonproduction API keys use bp_test_. Keep separate keys, secrets and configuration for each environment. Do not infer an API origin from the documentation hostname.
Integrate against the contract
Download the public v1 OpenAPI schema. It includes only the six read operations documented here. Handle nulls and finite error codes exactly as specified. Do not rely on internal /api/v1 portal routes or private fields.