Read a Verify execution result
curl --request GET \
--url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/executions/{execution_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/executions/{execution_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/verify/repositories/{repository_id}/executions/{execution_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"snapshot": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 1,
"definition": {
"title": "<string>",
"user": "<string>",
"goal": "<string>",
"tasks": [
"<string>"
],
"assertions": [
"<string>"
],
"tags": [
"<string>"
]
}
},
"observed_bugs": [
{
"title": "<string>",
"description": "<string>",
"reproductionSteps": [
"<string>"
],
"expectedBehavior": "<string>",
"actualBehavior": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"observed_testability": [
{
"title": "<string>",
"blocker": "<string>",
"impact": "<string>",
"suggestedRemediation": "<string>",
"evidenceArtifactIds": [
"<string>"
],
"blockedTasks": [
24
]
}
],
"outcome": {
"status": "passed",
"summary": "<string>",
"bugs": [
{
"title": "<string>",
"description": "<string>",
"reproductionSteps": [
"<string>"
],
"expectedBehavior": "<string>",
"actualBehavior": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"testabilityIssues": [
{
"title": "<string>",
"blocker": "<string>",
"impact": "<string>",
"suggestedRemediation": "<string>",
"evidenceArtifactIds": [
"<string>"
],
"blockedTasks": [
24
]
}
],
"bugAssessments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assessment": "reproduced",
"reason": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"testabilityAssessments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assessment": "reproduced",
"reason": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"evidence": [
{
"schemaVersion": 3,
"artifactId": "<string>",
"scenarioId": "<string>",
"kind": "text",
"title": "<string>",
"mimeType": "<string>",
"byteSize": 134217728,
"sha256": "<string>",
"capturedAt": "2023-11-07T05:31:56Z",
"producer": "qa_agent",
"provenance": "<string>",
"redactionStatus": "not_needed",
"textExcerpt": "<string>",
"videoTimeline": {
"version": 1,
"durationMs": 1,
"timing": "command-window",
"markers": [
{
"id": "<string>",
"targetId": "<string>",
"label": "<string>",
"startMs": 1,
"endMs": 1,
"kind": "assertion",
"result": "passed"
}
],
"edit": {
"version": 1,
"sourceArtifactId": "<string>",
"sourceDurationMs": 1,
"keptRanges": [
{
"startMs": 1,
"endMs": 1
}
]
}
}
}
],
"sessionRecording": {
"status": "complete",
"artifactIds": [
"<string>"
],
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"reason": "<string>"
},
"deviations": [
{
"deviationId": "<string>",
"intendedStep": "<string>",
"blocker": "<string>",
"alternative": "<string>",
"validityImpact": "none",
"changedState": [
"<string>"
],
"cleanup": [
"<string>"
],
"evidenceArtifactIds": [
"<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
}
}Read a Verify execution result
Reads the native journey snapshot and outcome. A completed job does not imply a passing execution. Evidence excludes storage keys, sandbox paths and rejected artifacts.
GET
/
v1
/
verify
/
repositories
/
{repository_id}
/
executions
/
{execution_id}
Read a Verify execution result
curl --request GET \
--url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/executions/{execution_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/executions/{execution_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/verify/repositories/{repository_id}/executions/{execution_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"snapshot": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 1,
"definition": {
"title": "<string>",
"user": "<string>",
"goal": "<string>",
"tasks": [
"<string>"
],
"assertions": [
"<string>"
],
"tags": [
"<string>"
]
}
},
"observed_bugs": [
{
"title": "<string>",
"description": "<string>",
"reproductionSteps": [
"<string>"
],
"expectedBehavior": "<string>",
"actualBehavior": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"observed_testability": [
{
"title": "<string>",
"blocker": "<string>",
"impact": "<string>",
"suggestedRemediation": "<string>",
"evidenceArtifactIds": [
"<string>"
],
"blockedTasks": [
24
]
}
],
"outcome": {
"status": "passed",
"summary": "<string>",
"bugs": [
{
"title": "<string>",
"description": "<string>",
"reproductionSteps": [
"<string>"
],
"expectedBehavior": "<string>",
"actualBehavior": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"testabilityIssues": [
{
"title": "<string>",
"blocker": "<string>",
"impact": "<string>",
"suggestedRemediation": "<string>",
"evidenceArtifactIds": [
"<string>"
],
"blockedTasks": [
24
]
}
],
"bugAssessments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assessment": "reproduced",
"reason": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"testabilityAssessments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assessment": "reproduced",
"reason": "<string>",
"evidenceArtifactIds": [
"<string>"
]
}
],
"evidence": [
{
"schemaVersion": 3,
"artifactId": "<string>",
"scenarioId": "<string>",
"kind": "text",
"title": "<string>",
"mimeType": "<string>",
"byteSize": 134217728,
"sha256": "<string>",
"capturedAt": "2023-11-07T05:31:56Z",
"producer": "qa_agent",
"provenance": "<string>",
"redactionStatus": "not_needed",
"textExcerpt": "<string>",
"videoTimeline": {
"version": 1,
"durationMs": 1,
"timing": "command-window",
"markers": [
{
"id": "<string>",
"targetId": "<string>",
"label": "<string>",
"startMs": 1,
"endMs": 1,
"kind": "assertion",
"result": "passed"
}
],
"edit": {
"version": 1,
"sourceArtifactId": "<string>",
"sourceDurationMs": 1,
"keptRanges": [
{
"startMs": 1,
"endMs": 1
}
]
}
}
}
],
"sessionRecording": {
"status": "complete",
"artifactIds": [
"<string>"
],
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"reason": "<string>"
},
"deviations": [
{
"deviationId": "<string>",
"intendedStep": "<string>",
"blocker": "<string>",
"alternative": "<string>",
"validityImpact": "none",
"changedState": [
"<string>"
],
"cleanup": [
"<string>"
],
"evidenceArtifactIds": [
"<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 "/verify/repositories/$REPOSITORY_ID/executions/$EXECUTION_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_verify_execution tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_verify_execution",
"arguments": {
"repository_id": "<repository_id>",
"execution_id": "<execution_id>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Path Parameters
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:
1Response
OK
Was this page helpful?