curl --request POST \
--url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "<string>",
"branch": "<string>",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuj_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": [
"<string>"
],
"expected_list_revision": 4503599627370495,
"expected_config_revision": 4503599627370495,
"prompt": "<string>",
"previous_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs"
payload = {
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "<string>",
"branch": "<string>",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuj_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"tags": ["<string>"],
"expected_list_revision": 4503599627370495,
"expected_config_revision": 4503599627370495,
"prompt": "<string>",
"previous_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
org_id: '<string>',
branch: '<string>',
environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
cuj_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
tags: ['<string>'],
expected_list_revision: 4503599627370495,
expected_config_revision: 4503599627370495,
prompt: '<string>',
previous_task_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs', 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/verify/repositories/{repository_id}/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'org_id' => '<string>',
'branch' => '<string>',
'environment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'cuj_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'tags' => [
'<string>'
],
'expected_list_revision' => 4503599627370495,
'expected_config_revision' => 4503599627370495,
'prompt' => '<string>',
'previous_task_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs"
payload := strings.NewReader("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_id\": \"<string>\",\n \"branch\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cuj_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"expected_list_revision\": 4503599627370495,\n \"expected_config_revision\": 4503599627370495,\n \"prompt\": \"<string>\",\n \"previous_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-coderabbitai-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs")
.header("x-coderabbitai-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_id\": \"<string>\",\n \"branch\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cuj_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"expected_list_revision\": 4503599627370495,\n \"expected_config_revision\": 4503599627370495,\n \"prompt\": \"<string>\",\n \"previous_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_id\": \"<string>\",\n \"branch\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cuj_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"expected_list_revision\": 4503599627370495,\n \"expected_config_revision\": 4503599627370495,\n \"prompt\": \"<string>\",\n \"previous_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 4503599627370495
}
}Start an existing Verify authoring, testability or execution operation
Accepts a job and returns its job_id, not a completed result. Poll get_verify_job, then read each execution with get_verify_execution for its actual verdict and evidence.
curl --request POST \
--url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "<string>",
"branch": "<string>",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuj_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": [
"<string>"
],
"expected_list_revision": 4503599627370495,
"expected_config_revision": 4503599627370495,
"prompt": "<string>",
"previous_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs"
payload = {
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "<string>",
"branch": "<string>",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuj_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"tags": ["<string>"],
"expected_list_revision": 4503599627370495,
"expected_config_revision": 4503599627370495,
"prompt": "<string>",
"previous_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
org_id: '<string>',
branch: '<string>',
environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
cuj_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
tags: ['<string>'],
expected_list_revision: 4503599627370495,
expected_config_revision: 4503599627370495,
prompt: '<string>',
previous_task_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs', 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/verify/repositories/{repository_id}/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'org_id' => '<string>',
'branch' => '<string>',
'environment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'cuj_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'tags' => [
'<string>'
],
'expected_list_revision' => 4503599627370495,
'expected_config_revision' => 4503599627370495,
'prompt' => '<string>',
'previous_task_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs"
payload := strings.NewReader("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_id\": \"<string>\",\n \"branch\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cuj_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"expected_list_revision\": 4503599627370495,\n \"expected_config_revision\": 4503599627370495,\n \"prompt\": \"<string>\",\n \"previous_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-coderabbitai-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs")
.header("x-coderabbitai-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_id\": \"<string>\",\n \"branch\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cuj_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"expected_list_revision\": 4503599627370495,\n \"expected_config_revision\": 4503599627370495,\n \"prompt\": \"<string>\",\n \"previous_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"org_id\": \"<string>\",\n \"branch\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cuj_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"expected_list_revision\": 4503599627370495,\n \"expected_config_revision\": 4503599627370495,\n \"prompt\": \"<string>\",\n \"previous_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 4503599627370495
}
}Authorizations
API key for authentication. You can create an API key from the CodeRabbit dashboard.
Path Parameters
Verify registration UUID returned as id by list_verify_repositories; not the provider repository ID.
Body
map, add, edit, revise, execute Caller-generated UUID identifying this start request. Reuse it when retrying the same request.
Organization selected by a workspace API key; omit for an organization-bound key or MCP connection.
11 - 255Optional execution environment override, accepted only for operation=execute.
Selected registered journey UUIDs. Omit to use the native journey selection; cannot be combined with tags.
50501 - 1000 <= x <= 90071992547409910 <= x <= 90071992547409911 - 30000Response
OK
Was this page helpful?