Preview effective repository configuration without saving
curl --request POST \
--url https://api.coderabbit.ai/v1/repositories/{repository_id}/configuration/preview \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"settings": {
"language": "en-US",
"tone_instructions": "",
"early_access": false,
"enable_free_tier": true,
"inheritance": false,
"reviews": {},
"chat": {},
"knowledge_base": {},
"code_generation": {},
"issue_enrichment": {}
},
"org_id": "<string>",
"org_name": "<string>",
"enabled": true,
"settings_yaml": "<string>",
"expected_settings_updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.coderabbit.ai/v1/repositories/{repository_id}/configuration/preview"
payload = {
"settings": {
"language": "en-US",
"tone_instructions": "",
"early_access": False,
"enable_free_tier": True,
"inheritance": False,
"reviews": {},
"chat": {},
"knowledge_base": {},
"code_generation": {},
"issue_enrichment": {}
},
"org_id": "<string>",
"org_name": "<string>",
"enabled": True,
"settings_yaml": "<string>",
"expected_settings_updated_at": "2023-11-07T05:31:56Z"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
language: 'en-US',
tone_instructions: '',
early_access: false,
enable_free_tier: true,
inheritance: false,
reviews: {},
chat: {},
knowledge_base: {},
code_generation: {},
issue_enrichment: {}
},
org_id: '<string>',
org_name: '<string>',
enabled: true,
settings_yaml: '<string>',
expected_settings_updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.coderabbit.ai/v1/repositories/{repository_id}/configuration/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"complete": true,
"yaml": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Preview effective repository configuration without saving
Resolves the effective YAML that would apply if the supplied repository settings were saved. Saves nothing. Returns complete false with a reason when the preview cannot be resolved. Availability matches the GitHub Cloud preview feature.
POST
/
v1
/
repositories
/
{repository_id}
/
configuration
/
preview
Preview effective repository configuration without saving
curl --request POST \
--url https://api.coderabbit.ai/v1/repositories/{repository_id}/configuration/preview \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"settings": {
"language": "en-US",
"tone_instructions": "",
"early_access": false,
"enable_free_tier": true,
"inheritance": false,
"reviews": {},
"chat": {},
"knowledge_base": {},
"code_generation": {},
"issue_enrichment": {}
},
"org_id": "<string>",
"org_name": "<string>",
"enabled": true,
"settings_yaml": "<string>",
"expected_settings_updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.coderabbit.ai/v1/repositories/{repository_id}/configuration/preview"
payload = {
"settings": {
"language": "en-US",
"tone_instructions": "",
"early_access": False,
"enable_free_tier": True,
"inheritance": False,
"reviews": {},
"chat": {},
"knowledge_base": {},
"code_generation": {},
"issue_enrichment": {}
},
"org_id": "<string>",
"org_name": "<string>",
"enabled": True,
"settings_yaml": "<string>",
"expected_settings_updated_at": "2023-11-07T05:31:56Z"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
language: 'en-US',
tone_instructions: '',
early_access: false,
enable_free_tier: true,
inheritance: false,
reviews: {},
chat: {},
knowledge_base: {},
code_generation: {},
issue_enrichment: {}
},
org_id: '<string>',
org_name: '<string>',
enabled: true,
settings_yaml: '<string>',
expected_settings_updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.coderabbit.ai/v1/repositories/{repository_id}/configuration/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"complete": true,
"yaml": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/repositories/$REPOSITORY_ID/configuration/preview" --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
preview_repository_configuration tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "preview_repository_configuration",
"arguments": {
"repository_id": "<repository_id>",
"settings": {}
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Body
application/json
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Was this page helpful?