canonical: https://jentic.com/apis/coderabbit.ai/coderabbit

# CodeRabbit API

CodeRabbit is an AI code-review platform, and this API covers the account-management surface around it. With an API key, an integration can generate on-demand review reports for a date range, read pull-request review metrics, list users, manage seat allocations and the seat-assignment mode, and set user roles. It is the administrative companion to CodeRabbit's automated pull-request reviews.

## For AI agents

Lets an AI agent generate CodeRabbit review reports and manage users, seats, and roles with an API key.

## Scope

Does not configure review rules or run the reviews itself: use it for CodeRabbit reporting and user, seat, and role administration only.

## Capabilities

- Generate an on-demand code-review report for a date range
- Read pull-request review metrics
- List users in the CodeRabbit organization
- Allocate and manage review seats
- Get and set the seat-assignment mode
- Assign roles to users

## Use cases

### Engineering review reporting

Engineering leads want a regular summary of code-review activity. The CodeRabbit API generates a report for a date range and exposes review metrics, so a reporting job can produce weekly review statistics without manual collection.

Example prompt: Generate a review report for the past week and read the review metrics for a summary

### Seat and license administration

Teams managing CodeRabbit licenses need to assign and reclaim seats as developers join and leave. The API lists users, manages seat allocations, and sets the seat-assignment mode so onboarding can be automated.

Example prompt: List users, assign a seat to a new developer, and set the seat-assignment mode to automatic

### Agent-driven review operations

A developer-experience agent can keep review tooling tidy on request. Through Jentic, an agent resolves a request like preparing a new hire into listing users, assigning a seat, and setting the right role.

Example prompt: Onboard a developer by assigning a review seat and granting the appropriate role

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/report.generate` | Generate a code-review report |
| GET | `/v1/metrics/reviews` | Get pull-request review metrics |
| GET | `/v1/users` | List users |
| POST | `/v1/users/seats` | Manage review seats |
| POST | `/v1/users/roles` | Assign user roles |

## Key resources

- **Reports** — Generate on-demand code-review reports for a date range
- **Metrics** — Read pull-request review metrics
- **Users** — List users in the organization
- **Seats** — Allocate seats and manage the seat-assignment mode
- **Roles** — Assign roles to users

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 72 / 100
  - AI-Readiness & Agent Experience: 58 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 64 / 100
- **View full report:** https://jentic.com/apis/coderabbit.ai/coderabbit/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** CodeRabbit wiring is one API key plus seven admin operations. With Jentic One you install once, import them from the API Directory, and keep the key in a single place.
- **Permission scoping:** Operations act on org-level resources rather than per-repository ids, so scoping is at the operation level: an agent can be limited to reading metrics while seat and role writes are withheld.
- **Credential handling:** Your CodeRabbit API key is stored encrypted by your own Jentic One instance and injected when a call runs, so it never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents find the right CodeRabbit operation through Jentic's intent search, matching a request like generating a code-review report to the matching endpoint.

## Related APIs

- **SonarCloud** — Static code-quality and security analysis in CI
- **Snyk** — Dependency and code vulnerability scanning
- **GitLab** — Source control and merge requests where reviews happen

## FAQ

### How does the CodeRabbit API authenticate?

CodeRabbit authenticates with an API key sent in the `x-coderabbitai-api-key` header, as declared in its OpenAPI spec. Jentic One stores that key and injects it at execution time.

### Can I limit what my agent is allowed to do in CodeRabbit?

Yes. You import only the operations an agent needs, so a reporting agent can read metrics and generate reports while seat and role changes stay out of scope.

### Does this API run the code reviews itself?

No. The automated reviews run in CodeRabbit's connected source-control app; this API covers reporting and account administration around them.

### What does the report generation operation return?

It produces an on-demand code-review report for the date range you request, which you can read back as structured data for dashboards or summaries.

### Can I manage CodeRabbit seats and roles through the API?

Yes. The API lists users, allocates seats, sets the seat-assignment mode, and assigns roles, so license administration can be automated.