> ## Documentation Index > Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt > Use this file to discover all available pages before exploring further. # Read an architecture knowledge document at an observed revision > Returns one architecture knowledge file at the revision from get_architecture_tree. Returns state stale when the revision is no longer current, too-large for files over 1 MiB, and absent when no knowledge exists. > [tab] CLI Tool > > ```bash > coderabbit api request "/knowledge/architecture/document?kind=$KIND&revision=$REVISION&path=$PATH" > ``` > > To install and sign in to the CLI, see [Call from the CLI](https://docs.coderabbit.ai/api/cli.md). > [tab] MCP Server > > An agent connected to the [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) runs this operation as the `get_architecture_document` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`. > > ```json > { > "method": "tools/call", > "params": { > "name": "get_architecture_document", > "arguments": { > "kind": "repository", > "revision": "", > "path": "" > } > } > } > ``` ## OpenAPI ````yaml /openapi.json get /v1/knowledge/architecture/document openapi: 3.0.0 info: title: CodeRabbit API version: 1.0.0 description: >- Read and manage CodeRabbit reviews, coding tasks, Verify, Triage, security findings, Knowledge Base, configuration, and users for your organization. servers: - url: https://api.coderabbit.ai description: US region - url: https://api.eu.coderabbit.ai description: EU region security: - ApiKeyAuth: [] tags: - name: Organizations and repositories - name: Pull requests and reviews - name: Coding Agent - name: Coding environments - name: Verify - name: Triage - name: Security - name: Knowledge Base - name: Automations - name: Reports - name: Configuration - name: Connections - name: Users and roles - name: Usage and metrics paths: /v1/knowledge/architecture/document: get: tags: - Knowledge Base summary: Read an architecture knowledge document at an observed revision description: >- Returns one architecture knowledge file at the revision from get_architecture_tree. Returns state stale when the revision is no longer current, too-large for files over 1 MiB, and absent when no knowledge exists. operationId: get_architecture_document parameters: - name: org_id in: query required: false schema: type: string minLength: 1 description: >- 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. allowEmptyValue: true allowReserved: true - name: org_name in: query required: false schema: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$ description: >- 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. allowEmptyValue: true allowReserved: true - name: kind in: query required: true schema: enum: - repository - organization - organization-security type: string allowEmptyValue: true allowReserved: true - name: repository_id in: query required: false schema: type: string minLength: 1 maxLength: 1000 allowEmptyValue: true allowReserved: true - name: revision in: query required: true schema: type: string pattern: ^git-[a-f0-9]{40}$ allowEmptyValue: true allowReserved: true - name: path in: query required: true schema: type: string minLength: 1 maxLength: 4096 allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: anyOf: - type: object properties: state: enum: - absent required: - state additionalProperties: false - type: object properties: state: enum: - stale revision: anyOf: - type: string pattern: ^git-[a-f0-9]{40}$ - type: string nullable: true enum: - null required: - state - revision additionalProperties: false - type: object properties: state: enum: - too-large revision: type: string pattern: ^git-[a-f0-9]{40}$ path: type: string required: - state - revision - path additionalProperties: false - type: object properties: state: enum: - ready revision: type: string pattern: ^git-[a-f0-9]{40}$ path: type: string content: type: string maxLength: 1048576 required: - state - revision - path - content additionalProperties: false '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: code: enum: - invalid_request type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: code: enum: - unauthenticated type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: code: enum: - forbidden type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: code: enum: - not_found type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '409': description: Conflict content: application/json: schema: type: object properties: error: type: object properties: code: enum: - head_changed - conflict type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '412': description: Precondition failed content: application/json: schema: type: object properties: error: type: object properties: code: enum: - precondition_failed type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: Content too large content: application/json: schema: type: object properties: error: type: object properties: code: enum: - payload_too_large type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: Too many requests content: application/json: schema: type: object properties: error: type: object properties: code: enum: - rate_limit_exceeded type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: code: enum: - internal_error type: string message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: Service unavailable content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - unavailable message: type: string retry_after: type: integer minimum: 0 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-coderabbitai-api-key description: >- See [Authentication](/api/authentication) for the key types and where to create a key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.