Read an ordinary Automation and its editable definition
curl --request GET \
--url https://api.coderabbit.ai/v1/automations/{automation_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/automations/{automation_id}"
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/automations/{automation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "<string>",
"title": "<string>",
"summary": "<string>",
"status": "active",
"revision": 1,
"updated_at": "2023-11-07T05:31:56Z",
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z"
},
"definition": {
"title": "<string>",
"taskPrompt": "<string>",
"trigger": {
"kind": "recurring",
"schedule": {
"frequency": "minutely",
"interval": 1,
"timezone": "UTC",
"hour": 11,
"minute": 29,
"dayOfMonth": 16,
"weekdays": [
"monday"
]
}
},
"summary": "<string>",
"messagePlatformPostingPrompt": "<string>",
"status": "active",
"destinations": [
{
"kind": "message_platform",
"provider": "slack",
"channelId": "<string>",
"channelName": "<string>"
}
],
"deliveryMode": "fresh_thread",
"messagePlatformTargetEnabled": true,
"subscribeToThreadUpdates": true,
"threadUpdateMatch": {
"mode": "all_messages"
},
"executionLocation": "conversation",
"homePresentation": {
"liveStatus": "show",
"finalReply": "show"
},
"messagePlatformProvider": "slack",
"channelId": "<string>",
"channelName": "<string>",
"slackDmPolicy": {
"mode": "creator",
"allowFiles": true
},
"botChannelSecondaryDestination": {
"provider": "slack",
"channelId": "<string>",
"channelName": "<string>"
},
"actions": [
{
"type": "prompt_run",
"actionId": "<string>",
"label": "<string>",
"prompt": "<string>",
"style": "primary"
}
],
"finalReplyActionPropagation": "every_reply",
"execution": {
"kind": "single_prompt"
}
}
}{
"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
}
}Read an ordinary Automation and its editable definition
Use data.revision as expected_revision when updating or commanding. The definition retains native trigger and destination fields and can be supplied unchanged to update. Factory targets are not exposed.
GET
/
v1
/
automations
/
{automation_id}
Read an ordinary Automation and its editable definition
curl --request GET \
--url https://api.coderabbit.ai/v1/automations/{automation_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/automations/{automation_id}"
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/automations/{automation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "<string>",
"title": "<string>",
"summary": "<string>",
"status": "active",
"revision": 1,
"updated_at": "2023-11-07T05:31:56Z",
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z"
},
"definition": {
"title": "<string>",
"taskPrompt": "<string>",
"trigger": {
"kind": "recurring",
"schedule": {
"frequency": "minutely",
"interval": 1,
"timezone": "UTC",
"hour": 11,
"minute": 29,
"dayOfMonth": 16,
"weekdays": [
"monday"
]
}
},
"summary": "<string>",
"messagePlatformPostingPrompt": "<string>",
"status": "active",
"destinations": [
{
"kind": "message_platform",
"provider": "slack",
"channelId": "<string>",
"channelName": "<string>"
}
],
"deliveryMode": "fresh_thread",
"messagePlatformTargetEnabled": true,
"subscribeToThreadUpdates": true,
"threadUpdateMatch": {
"mode": "all_messages"
},
"executionLocation": "conversation",
"homePresentation": {
"liveStatus": "show",
"finalReply": "show"
},
"messagePlatformProvider": "slack",
"channelId": "<string>",
"channelName": "<string>",
"slackDmPolicy": {
"mode": "creator",
"allowFiles": true
},
"botChannelSecondaryDestination": {
"provider": "slack",
"channelId": "<string>",
"channelName": "<string>"
},
"actions": [
{
"type": "prompt_run",
"actionId": "<string>",
"label": "<string>",
"prompt": "<string>",
"style": "primary"
}
],
"finalReplyActionPropagation": "every_reply",
"execution": {
"kind": "single_prompt"
}
}
}{
"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 "/automations/$AUTOMATION_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_automation tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_automation",
"arguments": {
"automation_id": "<automation_id>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Query Parameters
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?