Create a user journey

curl --request POST \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "cuj_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_list_revision": 1,
  "definition": {
    "title": "<string>",
    "user": "<string>",
    "goal": "<string>",
    "tasks": [
      "<string>"
    ],
    "assertions": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ]
  },
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys"

payload = {
    "cuj_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_list_revision": 1,
    "definition": {
        "title": "<string>",
        "user": "<string>",
        "goal": "<string>",
        "tasks": ["<string>"],
        "assertions": ["<string>"],
        "tags": ["<string>"]
    },
    "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({
    cuj_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_list_revision: 1,
    definition: {
      title: '<string>',
      user: '<string>',
      goal: '<string>',
      tasks: ['<string>'],
      assertions: ['<string>'],
      tags: ['<string>']
    },
    org_id: '<string>',
    org_name: '<string>'
  })
};

fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "journey_id": "<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
  }
}

POST

verify

repositories

{repository_id}

journeys

Create a user journey

curl --request POST \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "cuj_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_list_revision": 1,
  "definition": {
    "title": "<string>",
    "user": "<string>",
    "goal": "<string>",
    "tasks": [
      "<string>"
    ],
    "assertions": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ]
  },
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys"

payload = {
    "cuj_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_list_revision": 1,
    "definition": {
        "title": "<string>",
        "user": "<string>",
        "goal": "<string>",
        "tasks": ["<string>"],
        "assertions": ["<string>"],
        "tags": ["<string>"]
    },
    "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({
    cuj_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_list_revision: 1,
    definition: {
      title: '<string>',
      user: '<string>',
      goal: '<string>',
      tasks: ['<string>'],
      assertions: ['<string>'],
      tags: ['<string>']
    },
    org_id: '<string>',
    org_name: '<string>'
  })
};

fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "journey_id": "<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/journeys" --input request.json

To install and sign in to the CLI, see Call from the CLI.

An agent connected to the CodeRabbit MCP server runs this operation as the create_verify_journey tool. The connection selects the organization, so the arguments have no org_id or org_name.

{
  "method": "tools/call",
  "params": {
    "name": "create_verify_journey",
    "arguments": {
      "repository_id": "<repository_id>",
      "cuj_id": "<cuj_id>",
      "expected_list_revision": 1,
      "definition": {}
    }
  }
}

Authorizations

x-coderabbitai-api-key

string

header

required

See Authentication for the key types and where to create a key.

Path Parameters

repository_id

string<uuid>

required

Verify registration UUID returned as id by list_verify_repositories; not the provider repository ID.

Body

application/json

cuj_id

string<uuid>

required

expected_list_revision

integer

required

Required range: x >= 0

definition

object

required

Show child attributes

org_id

string

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: 1

org_name

string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

Response

journey_id

string

required

Basics

Clients

Guides

API reference

Create a user journey

Authorizations

Path Parameters

Body

Response