CodeRabbit Documentation - AI code reviews on pull requests, IDE, and CLI
Skip to main content
The CodeRabbit API provides programmatic access to review data, AI Deep Scan findings, and administrative operations. Use it to discover organizations and repositories, retrieve metrics and learnings, manage users and roles, or export audit logs and security findings.

​
Base URL and authentication

Send API requests to https://api.coderabbit.ai. Authenticate with the x-coderabbitai-api-key header:
The data and operations available to a request depend on the key’s scope:
  • Organization-scoped API keys are bound to one CodeRabbit organization.
  • Workspace API tokens let Enterprise SSO workspace admins call supported endpoints across organizations in a workspace.
  • Self-hosted instance API keys operate within a self-hosted CodeRabbit instance.
Review each endpoint’s requirements before sending a request. Workspace API tokens have additional organization-scoping rules for some endpoints.

​
Explore the API

Workspace API tokens

Create a workspace-scoped token and review its endpoint-specific request requirements.

Organizations and repositories

Discover active organizations and the repositories available within each organization.

Metrics and learnings

Retrieve pull request metrics and CodeRabbit learnings for reporting or analysis.

AI Deep Scan findings

Retrieve and export AI Deep Scan code findings for external security workflows.

Users and seats

List users, manage seats, and configure seat assignment.

Roles

List, create, update, and assign roles.

Audit logs

Export administrative activity for security and compliance workflows.

​
What’s next

Create a workspace API token

Set up one token for supported APIs across an Enterprise SSO workspace.

Open the API reference

Review endpoint parameters, request bodies, and response schemas.