CLclinicalauditai
Audits

Create a clinical audit

Generates an audit from the supplied source data.

The API may also generate a private PDF and return a temporary signed PDF URL. Email delivery can use the client's saved notification configuration or be explicitly requested in the request body.

Webhook delivery can be requested with webhook_url or use the client's saved webhook configuration.

post/audits

Request

Request body

datastring required

Source data to be analyzed by the ClinicalAuditAI API audit engine.

emailstring email

Optional email recipient. When omitted, the saved client notification email may be used.

notifyboolean

Whether email notification should be sent. When omitted, the client's saved preference may be used.

webhook_urlstring uri

Optional webhook URL. When omitted, a saved client webhook configuration may be used.

Example request

{
  "data": "Review informed consent documentation and protocol compliance.",
  "email": "compliance@example.com",
  "webhook_url": "https://client.example.com/webhooks/clinicalauditai"
}

Response

Audit generated successfully

audit_idstring uuid required
statusstring required
created_atstring date-time required
completed_atstring date-time required
resultstring required

Generated audit report text.

pdf_status'generated' | 'failed' required
pdf_urlstring uri nullable required

Temporary signed URL for the private PDF.

pdf_url_expires_ininteger nullable required
email_status'pending' | 'sent' | 'failed' | 'not_requested' required
webhook_status'pending' | 'sent' | 'failed' | 'not_requested' required

Example response

{
  "audit_id": "b9e24f03-5f08-44b8-bc60-a35fb44105d8",
  "status": "completed",
  "pdf_url_expires_in": 3600
}

Changes

No recorded changes to this operation across all 1 revision of this API.