Learnings

Programmatic access to an organization’s CodeRabbit learnings. Returns paginated JSON or a CSV download. Enterprise plan only. Mirrors the auth, rate-limit and response-size contract of the Metrics public API.

GET /v1/learnings

List learnings for an organization

cURL

curl --request GET \
  --url https://api.coderabbit.ai/v1/learnings \
  --header 'x-coderabbitai-api-key: <api-key>'

import requests

url = "https://api.coderabbit.ai/v1/learnings"

headers = {"x-coderabbitai-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/learnings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coderabbit.ai/v1/learnings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-coderabbitai-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coderabbit.ai/v1/learnings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-coderabbitai-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.coderabbit.ai/v1/learnings")
  .header("x-coderabbitai-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coderabbit.ai/v1/learnings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "<string>",
      "learning": "<string>",
      "repository_name": "<string>",
      "author_username": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "usage_count": 123,
      "organization_id": "<string>",
      "organization_name": "<string>",
      "repository_id": "<string>",
      "author_id": "<string>",
      "file": "<string>",
      "source_url": "<string>",
      "last_used_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

Programmatic access to an organization’s CodeRabbit learnings. Returns paginated JSON or a CSV download. Use the repository_ids, user_ids, organization_ids, limit, and cursor query parameters to filter and paginate results.

CSV Format

When using format=csv, the API returns a flat CSV structure with one row per learning. For the complete list of CSV columns and field descriptions, see Data Export - Exported fields.

For a guided overview of learnings, see the Learnings documentation.

Authorizations

x-coderabbitai-api-key · string · header · required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Headers

x-coderabbitai-api-key · string · required

API key for authentication

Query Parameters

org_id · string

Workspace-scoped API tokens only. When provided, scopes learnings to that single git-provider organization within the token's workspace; when omitted, aggregates every organization in the workspace. Ignored for organization and self-hosted keys.

repository_ids · string

Comma-separated provider repository IDs (max 10).

Example:

"1027529638,987654321"

user_ids · string

Comma-separated provider user IDs (max 10).

Example:

"87397876,12345678"

organization_ids · string

Comma-separated provider organization IDs (max 10). Self-hosted instances only.

Example:

"184456712,103539130"

limit · integer · default: 1000

Maximum number of records to return.

Required range: 1 <= x <= 1000

cursor · string

Pagination cursor returned as next_cursor on the previous page.

format · enum<string> · default: json

Response format. json (default) returns paginated JSON; csv returns a CSV download.

Available options: json, csv

Response

200

application/json

Successfully retrieved learnings.

data · object[] · required

Show child attributes

next_cursor · string | null · required