ClinicalAuditAI API v1

Clinical audit automation, built into your workflow.

Integrate ClinicalAuditAI directly into your healthcare application, clinical research workflow or internal audit system. Generate structured audit reports, PDFs, email notifications and signed webhooks programmatically.

No customer dashboard required. Integration is authenticated with your API key.

What you can build

One API. A complete audit workflow.

Send source material through the API and receive structured audit output without rebuilding the audit-generation workflow yourself.

01

Submit Audit Data

Send your audit source material through an authenticated API request.

02

Generate Report

ClinicalAuditAI structures the supplied information into an audit report.

03

Receive PDF

A private PDF is generated and returned through a time-limited signed URL.

04

Get Notified

Optionally deliver completion notifications by email or signed webhook.

Quick start

Make your first API request

Every customer request uses the X-API-Key header. Your client key is stored server-side as a hash.

curl -X POST "https://YOUR-API-ORIGIN/api/v1/audits" \
  -H "X-API-Key: YOUR_CLIENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "data": "Review informed consent documentation and protocol compliance."
  }'

API v1

Core endpoints

GET/api/v1/health

Check basic API service availability. Authentication is not required.

POST/api/v1/audits

Submit source data, generate a structured audit, create the PDF and optionally trigger email or webhook notification.

GET/api/v1/audits/<audit_id>

Retrieve an audit belonging to the authenticated client and receive a fresh signed PDF URL when available.

GET/api/v1/docs

Open the interactive Swagger UI for testing and exploring the API.

GET/api/v1/openapi.yaml

Retrieve the machine-readable OpenAPI specification.

Notifications

Email delivery

Configure an email recipient for completed audits. The notification can include a secure, time-limited link to the generated PDF.

  • ✓ Optional per-request notification
  • ✓ Saved client notification settings
  • ✓ Secure signed PDF link

Webhooks

Signed completion events

Receive an audit.completed event at your webhook endpoint with an HMAC-SHA256 signature.

  • ✓ Timestamped webhook requests
  • ✓ HMAC-SHA256 verification
  • ✓ Retry handling for transient failures

Security

Designed for controlled integrations

Each provisioned client receives its own API key. Client keys are stored server-side as hashes, and authenticated audit retrieval is scoped to the client that created the audit.

Client API keys

Use X-API-Key for authenticated requests.

Tenant isolation

Clients can retrieve only their own audit records.

Signed webhooks

Verify completion events using the webhook signature.

Ready to integrate?

Put clinical audit automation inside your application.

Explore the interactive documentation, review the OpenAPI specification, and build your integration around ClinicalAuditAI API v1.