Skip to main content
GET
Read an architecture knowledge document at an observed revision

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Query Parameters

org_id
string
Minimum string length: 1
kind
enum<string>
required
Available options:
repository,
organization,
organization-security
repository_id
string
Required string length: 1 - 1000
revision
string
required
Pattern: ^git-[a-f0-9]{40}$
path
string
required
Required string length: 1 - 4096

Response

OK

state
enum<string>
required
Available options:
absent