v1 · Last updated: 2026-03-24
The Open Code Review Cloud API lets you manage licenses, submit code scans, and retrieve reports programmatically. All responses are JSON.
Most endpoints require a Bearer token. Obtain one via /api/auth/login, then include it in your request headers:
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Security Note
Never expose tokens in client-side code. Use environment variables or a secret manager. Tokens expire after 24 hours.
https://cloud.opencodereview.com
All endpoint paths are relative to this base URL.
API requests are rate-limited. Exceeding the limit returns HTTP 429 with a Retry-After header.
| Plan | Rate | Daily | Scans |
|---|---|---|---|
| Free | 60 requests/min | 1,000/day | 10 scans/day |
| Team | 300 requests/min | 10,000/day | 100 scans/day |
| Enterprise | Custom | Custom | Unlimited |
All error responses follow a consistent format:
{
"error": {
"code": 401,
"message": "Invalid or expired access token",
"details": null
}
}| Code | Name | Description |
|---|---|---|
| 400 | Bad Request | Invalid request body or parameters |
| 401 | Unauthorized | Missing or invalid access token |
| 403 | Forbidden | Insufficient permissions for this action |
| 404 | Not Found | Resource not found |
| 409 | Conflict | Resource already exists (e.g., duplicate email) |
| 429 | Too Many Requests | Rate limit exceeded. Retry after the Retry-After header value. |
| 500 | Internal Error | Unexpected server error |
Quick examples in popular languages to get you started.
const res = await fetch('https://cloud.opencodereview.com/api/scans', {
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.OCR_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
repositoryUrl: 'https://github.com/your/repo',
level: 'l3',
}),
});
const scan = await res.json();
console.log('Scan ID:', scan.id);import requests, os
resp = requests.post(
"https://cloud.opencodereview.com/api/scans",
headers={"Authorization": f"Bearer {os.environ['OCR_TOKEN']}"},
json={
"repositoryUrl": "https://github.com/your/repo",
"level": "l3",
},
)
scan = resp.json()
print(f"Scan ID: {scan['id']}")# Submit a scan
curl -X POST https://cloud.opencodereview.com/api/scans \
-H "Authorization: Bearer $OCR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"repositoryUrl":"https://github.com/your/repo","level":"l3"}'
# Poll for results
curl https://cloud.opencodereview.com/api/scans/scan_abc123 \
-H "Authorization: Bearer $OCR_TOKEN"Sign up for a free account, grab your API token, and start integrating.