Skip to content
Developer API
Frisby AI Operations
Frisby AI Operations Enterprise AI Accuracy Platform

API Documentation

Integrate AI Accuracy Into Your Workflow — RESTful API access to all Frisby AI agents. Scan, validate, assess risk, and monitor compliance programmatically.

API access is available with Professional and Enterprise plans.
Try the API API Keys Usage Dashboard Endpoints
Authentication

API Key Authentication

All API requests must include your API key in the Authorization header. Keys are prefixed with fai_ for easy identification.

# Include your API key in every request Authorization: Bearer fai_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Key Format
fai_xxxxxxxxxxxxxxxxx

32-character alphanumeric key

Generate Keys

Dashboard → Settings → API Keys

Rotate keys at any time

Security

TLS 1.3 encrypted

Never share keys in client-side code

Quick Start

Get started in minutes

Everything you need to integrate Frisby AI into your application.

Base URL
https://api.frisbyaiops.com/v1
Authentication
Authorization: Bearer fai_xxxxx
Rate Limits
Free 100/mo · Pro 5,000/mo · Enterprise ∞
# Quick example curl -X POST https://api.frisbyaiops.com/v1/scan \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"text": "Your document text here", "industry": "healthcare"}'
Endpoints

API Reference

Six endpoints covering the full Frisby AI agent suite. Click to expand.

POST /v1/scan Run PII and compliance scan on text +

Analyzes document text for compliance gaps, factual inconsistencies, readability problems, and risk factors.

Request Body

{ "text": "Your document text here...", "industry": "healthcare", "options": { "customRules": [] } }

Response

{ "score": 78, "categories": { "structure": 85, "compliance": 72, "quality": 80, "risk": 74 }, "findings": [...], "metadata": { "scanId": "scn_a1b2c3d4", "timestamp": "2026-04-23T12:00:00Z", "tokensProcessed": 1247 } }
POST /v1/audit Run AI Content Auditor on text +

Audits text for hallucinations, bias, compliance issues, and tone problems.

Request Body

{ "text": "Your document text here...", "options": { "checkHallucinations": true, "checkBias": true, "checkCompliance": true } }

Response

{ "score": 82, "categories": { "accuracy": 88, "bias": 75, "compliance": 80, "tone": 85 }, "findings": [...] }
POST /v1/validate Run content validation on text +

Validates document content for factual accuracy, citation integrity, and logical consistency.

Request Body

{ "text": "Your document text here...", "options": { "checkCitations": true, "checkLogic": true, "checkFacts": true } }

Response

{ "score": 76, "categories": { "factual": 80, "citations": 70, "logic": 82, "consistency": 72 }, "findings": [...] }
POST /v1/compliance Run AI Content Auditor +

Scans text against industry-specific compliance frameworks and regulations.

Request Body

{ "text": "Your document text here...", "industry": "healthcare", "frameworks": ["HIPAA", "GDPR"] }

Response

{ "score": 68, "applicableRegulations": ["HIPAA", "HITECH", "GDPR Art. 9"], "categories": { "piiProtection": 55, "disclaimers": 70, "regulatoryLanguage": 78, "dataHandling": 65 }, "findings": [...] }
POST /v1/risk Run AI Content Auditor +

Generates a risk assessment with severity-ranked findings and a risk heat map.

Request Body

{ "text": "Your document text here...", "industry": "finance" }

Response

{ "score": 71, "riskLevel": "moderate", "heatMap": { "pii": "high", "compliance": "medium", "quality": "low", "legal": "medium" }, "findings": [...] }
POST /v1/pipeline Run full agent pipeline +

Runs the full pipeline: Scanner + Compliance + Risk in a single request. Returns per-agent scores and a combined verdict.

Request Body

{ "text": "Your document text here...", "industry": "healthcare", "agents": ["scanner", "compliance", "risk"] }

Response

{ "pipelineScore": 74, "verdict": "review_required", "agents": { "scanner": { "score": 78, "findings": 12 }, "compliance": { "score": 68, "findings": 8 }, "risk": { "score": 71, "findings": 5 } }, "metadata": { "pipelineId": "pip_x7y8z9", "totalFindings": 25, "processingTimeMs": 1847 } }

Additional Endpoints

POST /v1/analyze Universal analysis endpoint +

Unified endpoint that routes to any agent. Specify the tool and industry for customized analysis.

Request Body

{ "text": "Your document text here...", "tool": "auditor", "industry": "finance" }

Response

{ "score": 85, "findings": [ { "type": "Vague Quantifier", "severity": "low", "detail": "Imprecise term: several" } ], "dimensions": { "accuracy": 88, "bias": 82, "compliance": 90, "tone": 80 } }
POST /v1/batch Batch process multiple documents +

Submit multiple documents for parallel analysis. Returns individual results plus aggregate metrics.

Request Body

{ "documents": [ { "id": "doc_1", "text": "First document..." }, { "id": "doc_2", "text": "Second document..." } ], "tool": "scanner", "industry": "healthcare" }
POST /v1/compliance-check Framework-specific compliance check +

Checks text against specific compliance frameworks. Returns pass/fail status for each applicable regulation.

Request Body

{ "text": "Document text...", "frameworks": ["HIPAA", "SOC2", "GDPR"] }
GET /v1/frameworks List available compliance frameworks +

Returns all supported compliance frameworks and their applicable industries.

Response

{ "frameworks": [ { "id": "hipaa", "name": "HIPAA", "industries": ["healthcare"] }, { "id": "gdpr", "name": "GDPR", "industries": ["all"] }, { "id": "sox", "name": "SOX", "industries": ["finance"] } ] }
GET /v1/history Retrieve analysis history +

Retrieve past analysis results with pagination and filtering. Results are sorted by date descending.

Query Parameters

ParameterTypeDescription
limitintegerMax results to return (default: 20, max: 100)
offsetintegerPagination offset
toolstringFilter by tool: auditor, scanner, validator, etc.
fromISO dateFilter results after this date
Interactive

API Playground

Test API calls live. Select an endpoint, edit the request, and see real analysis results powered by the Frisby engine.

POST https://api.frisbyaiops.com/api/v1/audit
Request
Authorization: Bearer fai_live_demo_xxxxxxxxxx Content-Type: application/json
Response
// Send a request to see the response...

The /audit endpoint runs the real Frisby analysis engine on your text. Other endpoints return simulated responses. Production API returns deeper analysis with full agent pipelines.

Try It Live

API Playground

Test the analysis engine right here. Runs locally in your browser using the same engine that powers the API.

Request Body
Response 
// Click "Run" to see results
Key Management

Your API Keys

Manage your API keys. Generate, rotate, and revoke keys from your dashboard.

NameKeyCreatedLast UsedRequestsStatusActions

Keys are stored in your browser for demo purposes only. In production, keys are managed via your secure dashboard.

Usage

Usage Metering Dashboard

Monitor your API consumption in real time. Usage is tracked per billing period.

API Calls This Month
0
of 10,000 limit
Documents Processed
0
unique documents
Avg Response Time
--
milliseconds
Error Rate
0%
0 errors / 0 requests
Daily API Calls -- Last 14 Days
/audit
/scan
/validate
/report

Rate Limits by Plan

PlanRequests/minRequests/monthMax Doc Size
Essentials101,00010 KB
Professional305,00050 KB
Professional6010,000100 KB
Enterprise300Unlimited1 MB
Code Examples

Integrate in minutes

Copy-paste examples for the /audit endpoint in your language of choice.

curl -X POST https://api.frisbyaiops.com/api/v1/audit \ -H "Authorization: Bearer fai_live_xxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "text": "Revenue increased significantly compared to the previous quarter. Studies show that companies in our sector typically outperform.", "options": { "checkHallucinations": true, "checkBias": true, "checkCompliance": true } }'
import requests url = "https://api.frisbyaiops.com/api/v1/audit" headers = { "Authorization": "Bearer fai_live_xxxxxxxxxxxx", "Content-Type": "application/json" } payload = { "text": "Revenue increased significantly compared to the previous quarter.", "options": { "checkHallucinations": True, "checkBias": True, "checkCompliance": True } } response = requests.post(url, headers=headers, json=payload) result = response.json() print(f"Score: {result['score']}") print(f"Findings: {len(result['findings'])}") for finding in result["findings"]: print(f" [{finding['severity']}] {finding['detail']}")
const response = await fetch("https://api.frisbyaiops.com/api/v1/audit", { method: "POST", headers: { "Authorization": "Bearer fai_live_xxxxxxxxxxxx", "Content-Type": "application/json" }, body: JSON.stringify({ text: "Revenue increased significantly compared to the previous quarter.", options: { checkHallucinations: true, checkBias: true, checkCompliance: true } }) }); const data = await response.json(); console.log(`Score: ${data.score}`); console.log(`Dimensions:`, data.dimensions);
const axios = require("axios"); async function auditDocument(text) { const { data } = await axios.post( "https://api.frisbyaiops.com/api/v1/audit", { text, options: { checkHallucinations: true, checkBias: true, checkCompliance: true } }, { headers: { "Authorization": "Bearer fai_live_xxxxxxxxxxxx", "Content-Type": "application/json" } } ); console.log(`Audit score: ${data.score}`); console.log(`Findings: ${data.findings.length}`); return data; } auditDocument("Your document text here...");
Plans

Rate Limits & Pricing

Choose the plan that fits your integration needs.

PlanRequests/HourAgentsBatchWebhooks
Free100/monthScanner onlyNoNo
Professional5,000/monthAll agentsYes (50 docs)Yes
EnterpriseUnlimitedAll + customYes (500 docs)Yes
Get API Access
Reference

Error Codes

CodeMeaning
200Success
400Invalid request body — check JSON syntax and required fields
401Invalid or missing API key
403Plan doesn't include this endpoint
429Rate limit exceeded — retry after the indicated time
500Internal server error — contact support if persistent
Webhooks

Asynchronous Results

Configure webhooks to receive scan results asynchronously for batch processing. Webhook payloads match the standard response format for each endpoint.

{ "event": "scan.completed", "webhookId": "wh_r4s5t6", "timestamp": "2026-04-23T14:30:00Z", "data": { "scanId": "scn_a1b2c3d4", "score": 78, "categories": { "structure": 85, "compliance": 72, "quality": 80, "risk": 74 }, "findings": [...] } }

Webhook endpoints must return a 200 status within 10 seconds. Failed deliveries are retried up to 3 times with exponential backoff. Available on Professional and Enterprise plans.

FAQ

Frequently asked questions

Sign up for any paid plan at frisbyaiops.com/pricing. Your API key is generated automatically and available in your dashboard. Professional and Enterprise plans include full API access; Essentials plans provide access to the Scanner endpoint only.

Essentials plans allow 100 requests per hour, Professional plans allow 1,000 requests per hour, and Enterprise plans have no rate limits. If you exceed your limit, you will receive a 429 status code with a Retry-After header indicating when you can resume.

Yes. Professional plans support batch processing of up to 50 documents per request, and Enterprise plans support up to 500. Use the batch endpoint or configure webhooks to receive results asynchronously as each document completes processing.

All API traffic is encrypted with TLS 1.3. Documents are processed in memory and never stored on disk. Enterprise plans include dedicated infrastructure, enhanced security controls, and optional data residency configuration. We do not use your data for training.

Ready to integrate?

Get API access and start building AI accuracy into your workflows today.

Get API Access Try the API