> ## 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 ## OpenAPI ````yaml /openapi.json get /v1/knowledge/architecture/document openapi: 3.0.3 info: title: CodeRabbit API spec version: 1.0.0 servers: - url: https://api.coderabbit.ai security: - ApiKeyAuth: [] paths: /v1/knowledge/architecture/document: get: tags: - Architecture knowledge summary: Read an architecture knowledge document at an observed revision operationId: get_architecture_document parameters: - name: org_id in: query required: false schema: type: string minLength: 1 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: '400' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: '401' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: '403' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '404': description: '404' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '409': description: '409' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '412': description: '412' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: '413' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: '429' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: '500' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: '503' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-coderabbitai-api-key description: >- API key for authentication. You can create an API key from the CodeRabbit dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.