Create a coding environment with existing preparation behavior
curl --request POST \
--url https://api.coderabbit.ai/v1/code/environments \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"name": "<string>",
"repositories": [
{
"repository": {
"repositoryId": "<string>",
"repositoryName": "<string>"
},
"setup": {
"setupMethod": "automatic",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>"
}
}
],
"description": "<string>",
"packages": [],
"variables": [],
"org_id": "<string>",
"org_name": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/code/environments"
payload = {
"name": "<string>",
"repositories": [
{
"repository": {
"repositoryId": "<string>",
"repositoryName": "<string>"
},
"setup": {
"setupMethod": "automatic",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>"
}
}
],
"description": "<string>",
"packages": [],
"variables": [],
"org_id": "<string>",
"org_name": "<string>"
}
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({
name: '<string>',
repositories: [
{
repository: {repositoryId: '<string>', repositoryName: '<string>'},
setup: {
setupMethod: 'automatic',
setupScript: '<string>',
startupScript: '<string>',
startupInstructions: '<string>'
}
}
],
description: '<string>',
packages: [],
variables: [],
org_id: '<string>',
org_name: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/code/environments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"environment": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "preparing",
"packages": [
{
"id": "python",
"version": "<string>"
}
],
"revision": 123,
"configurationVersion": "<string>",
"preparedRevision": 123,
"activeSnapshotRecordId": "<string>",
"repositoryCount": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"archivedAt": "<string>"
},
"repositories": [
{
"id": "<string>",
"environmentId": "<string>",
"repositoryProvider": "<string>",
"repositoryId": "<string>",
"repositoryName": "<string>",
"status": "preparing",
"machineSize": "<string>",
"setupMethod": "<string>",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>",
"configRevision": 123,
"preparedRevision": 123,
"setupAgentTaskId": "<string>",
"lastPreparedAt": "<string>",
"lastError": "<string>",
"createdAt": "<string>",
"updatedAt": "<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
}
}Create a coding environment with existing preparation behavior
Creates an environment with its packages, encrypted variables and 1 to 50 repositories, and starts environment preparation. Repositories start in the preparing status. The name is limited to 48 characters.
POST
/
v1
/
code
/
environments
Create a coding environment with existing preparation behavior
curl --request POST \
--url https://api.coderabbit.ai/v1/code/environments \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"name": "<string>",
"repositories": [
{
"repository": {
"repositoryId": "<string>",
"repositoryName": "<string>"
},
"setup": {
"setupMethod": "automatic",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>"
}
}
],
"description": "<string>",
"packages": [],
"variables": [],
"org_id": "<string>",
"org_name": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/code/environments"
payload = {
"name": "<string>",
"repositories": [
{
"repository": {
"repositoryId": "<string>",
"repositoryName": "<string>"
},
"setup": {
"setupMethod": "automatic",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>"
}
}
],
"description": "<string>",
"packages": [],
"variables": [],
"org_id": "<string>",
"org_name": "<string>"
}
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({
name: '<string>',
repositories: [
{
repository: {repositoryId: '<string>', repositoryName: '<string>'},
setup: {
setupMethod: 'automatic',
setupScript: '<string>',
startupScript: '<string>',
startupInstructions: '<string>'
}
}
],
description: '<string>',
packages: [],
variables: [],
org_id: '<string>',
org_name: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/code/environments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"environment": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "preparing",
"packages": [
{
"id": "python",
"version": "<string>"
}
],
"revision": 123,
"configurationVersion": "<string>",
"preparedRevision": 123,
"activeSnapshotRecordId": "<string>",
"repositoryCount": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"archivedAt": "<string>"
},
"repositories": [
{
"id": "<string>",
"environmentId": "<string>",
"repositoryProvider": "<string>",
"repositoryId": "<string>",
"repositoryName": "<string>",
"status": "preparing",
"machineSize": "<string>",
"setupMethod": "<string>",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>",
"configRevision": 123,
"preparedRevision": 123,
"setupAgentTaskId": "<string>",
"lastPreparedAt": "<string>",
"lastError": "<string>",
"createdAt": "<string>",
"updatedAt": "<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 /code/environments --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
create_code_environment tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "create_code_environment",
"arguments": {
"name": "<name>",
"repositories": []
}
}
}
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?