Versioning and support

The current API uses the /api/v1 path. The downloadable OpenAPI file is the source of truth for HTTP operations, request fields, responses, and schemas.

Compatibility rules

• Ignore JSON fields and SSE event names your client does not recognize.
• Do not depend on response field order or undocumented fields.
• Treat operation IDs, error codes, event names, and enum values as case-sensitive wire values.
• Review OpenAPI changes before updating generated clients or validators.
• Test changed behavior in staging before deploying it to production.

Additive fields, response members, event names, and enum values can appear without changing the versioned path. A client that rejects unknown values will be harder to operate safely.

Capture request details

Keep the X-Request-ID response header with your local request record. For an SSE request, also retain the chat ID, user ID, event names received, UTC timestamps, and whether the HTTP stream closed normally. Do not log the Bearer token or unrestricted patient content.

Report an API problem

Send your Doctronic implementation contact:

• Staging or production environment.
• HTTP method and path.
• UTC time and X-Request-ID.
• Response status and machine-readable error code.
• Whether a retry used the same Idempotency-Key.
• The last safe workflow state, without credentials or unnecessary patient content.

If you do not have an implementation contact, email business@doctronic.ai. Do not send credentials or patient information by email.

Contract updates

The public reference is generated from the deployed production OpenAPI contract and checked daily for changes. Download the current contract from /openapi/doctronic-v1.json. Coordinate material workflow changes with Doctronic before enabling them in production.