POST/v1/audit/run

Run Brand Audit

Triggers a new Brand Audit for the authenticated workspace. The audit runs asynchronously and takes 2–5 minutes to complete. Poll the audit results endpoint or configure a webhook to receive notification when the audit completes.

Bearer token required. Minimum plan: Pro. Subject to monthly audit limits.

Request Body

Parameter	Type	Required	Description
`workspace_id`	string	Optional	Workspace ID. Defaults to primary workspace.
`platforms`	string[]	Optional	Platforms to include. Default: all connected platforms.
`lookback_days`	integer	Optional	Number of days to analyze. Default: 90. Max: 365.
`webhook_url`	string	Optional	URL to receive POST notification when audit completes.

Request

curl -X POST "https://api.onprism.io/v1/audit/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lookback_days": 90,
    "webhook_url": "https://yourapp.com/webhooks/prism-audit"
  }'

Response (200 OK)

{
  "audit_id": "aud_7f3k9x2m",
  "status": "processing",
  "estimated_completion": "2026-02-24T12:05:00Z",
  "workspace_id": "ws_abc123",
  "platforms_included": ["instagram", "tiktok", "youtube"],
  "lookback_days": 90
}

Error Codes

401

Unauthorized

Missing or invalid API key.

402

Audit Limit Reached

You've used all audit runs for this billing period.

409

Audit In Progress

An audit is already running for this workspace. Wait for it to complete.

422

No Platforms Connected

At least one platform must be connected to run an audit.

Score History

GET /v1/score/history

Get Audit Results

GET /v1/audit/{audit_id}