> ## 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 accessible Triage change ## OpenAPI ````yaml /openapi.json get /v1/triage/changes/{id} openapi: 3.0.3 info: title: CodeRabbit API spec version: 1.0.0 servers: - url: https://api.coderabbit.ai security: - ApiKeyAuth: [] paths: /v1/triage/changes/{id}: get: tags: - Triage summary: Read an accessible Triage change operationId: get_triage_change parameters: - name: id in: path required: true schema: type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ - name: org_id in: query schema: type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ external_id: type: string minLength: 1 provider: enum: - github - gitlab - bitbucket - azure-devops type: string provider_host: type: string minLength: 1 url: anyOf: - type: string maxLength: 2048 format: uri - type: string nullable: true enum: - null repository: type: object properties: id: anyOf: - type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ - type: string nullable: true enum: - null owner: type: string name: type: string required: - id - owner - name additionalProperties: false title: anyOf: - type: string - type: string nullable: true enum: - null state: enum: - open - merged - closed - unknown type: string author: anyOf: - type: object properties: id: anyOf: - type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ - type: string nullable: true enum: - null username: anyOf: - type: string - type: string nullable: true enum: - null name: anyOf: - type: string - type: string nullable: true enum: - null required: - id - username - name additionalProperties: false - type: string nullable: true enum: - null head_revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null latest_commit_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null latest_reviewable_observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null opened_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null age_seconds: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: string nullable: true enum: - null last_activity_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null last_human_activity_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null change_type: anyOf: - enum: - bugfix - feature - refactor type: string - type: string nullable: true enum: - null focus_state: anyOf: - enum: - now - next type: string - type: string nullable: true enum: - null priority: type: object properties: level: anyOf: - enum: - p0 - p1 - p2 - p3 - none type: string - type: string nullable: true enum: - null source: anyOf: - enum: - calculated - manual type: string - type: string nullable: true enum: - null reason: anyOf: - type: string - type: string nullable: true enum: - null reason_codes: type: array items: type: string score: anyOf: - type: number minimum: 0 maximum: 100 - type: string nullable: true enum: - null confidence: anyOf: - type: number minimum: 0 maximum: 1 - type: string nullable: true enum: - null override: anyOf: - type: object properties: level: enum: - p0 - p1 - p2 - p3 type: string required: - level additionalProperties: false - type: string nullable: true enum: - null required: - level - source - reason - reason_codes - score - confidence - override additionalProperties: false close_candidate: type: object properties: value: anyOf: - type: boolean - type: string nullable: true enum: - null status: enum: - available - unknown - stale - unsupported type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null source: anyOf: - enum: - manual - calculated type: string - type: string nullable: true enum: - null reason: anyOf: - type: string - type: string nullable: true enum: - null required: - value - status - observed_at - revision - source - reason additionalProperties: false requires_attention: anyOf: - type: boolean - type: string nullable: true enum: - null attention_reason_codes: type: array items: type: string next_action: type: object properties: kind: anyOf: - enum: - merge - review - find_reviewer - start_review - fix_checks - resolve_conflicts - autofix - refresh_branch - update_change - respond - decide - close - follow - notify - none type: string - type: string nullable: true enum: - null responsible_role: enum: - author - reviewer - maintainer - system - unknown type: string responsible_users: type: array items: type: object properties: id: anyOf: - type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ - type: string nullable: true enum: - null username: anyOf: - type: string - type: string nullable: true enum: - null name: anyOf: - type: string - type: string nullable: true enum: - null required: - id - username - name additionalProperties: false reason_codes: type: array items: type: string status: enum: - available - unknown type: string required: - kind - responsible_role - responsible_users - reason_codes - status additionalProperties: false review_status: anyOf: - type: object properties: status: enum: - available value: enum: - reviewed - new_changes_since_review - review_needed - review_starting - reviewing - review_failed - no_reviewable_changes type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false description: >- Review evidence. Unconfirmed in-progress observations use stale status with a null value; observed_at and revision retain the last observation. approval_status: anyOf: - type: object properties: status: enum: - available value: enum: - approved - changes_requested - review_required - stale_approval type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false blast_radius: anyOf: - type: object properties: status: enum: - available value: enum: - low - medium - high type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false merge_risk: anyOf: - type: object properties: status: enum: - available value: type: object properties: level: enum: - low - medium - high type: string score: type: number minimum: 0 maximum: 1 basis: enum: - direct - proxy - mixed - unknown type: string reason: anyOf: - type: string - type: string nullable: true enum: - null required: - level - score - basis - reason additionalProperties: false observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false security_risk: anyOf: - type: object properties: status: enum: - available value: type: object properties: level: enum: - minimal - low - moderate - high - critical type: string reason: anyOf: - type: string - type: string nullable: true enum: - null required: - level - reason additionalProperties: false observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false review_effort: anyOf: - type: object properties: status: enum: - available value: type: number minimum: 0 maximum: 1 observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false review_depth: anyOf: - type: object properties: status: enum: - available value: enum: - light - standard - deep - defer type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false participants: type: array items: type: object properties: user: type: object properties: id: anyOf: - type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ - type: string nullable: true enum: - null username: anyOf: - type: string - type: string nullable: true enum: - null name: anyOf: - type: string - type: string nullable: true enum: - null required: - id - username - name additionalProperties: false roles: type: array items: enum: - author - assignee - requested_reviewer - reviewer - approver - change_requester - commenter - subscriber - suggested_reviewer - codeowner_candidate type: string required: - user - roles additionalProperties: false blocked_change_count: anyOf: - type: object properties: status: enum: - available value: type: integer minimum: 0 maximum: 9007199254740991 observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false issue_severity: anyOf: - type: object properties: status: enum: - available value: enum: - low - medium - high type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false complexity: anyOf: - type: object properties: status: enum: - available value: type: integer minimum: 1 maximum: 5 observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false diff: anyOf: - type: object properties: status: enum: - available value: type: object properties: additions: type: integer minimum: 0 maximum: 9007199254740991 deletions: type: integer minimum: 0 maximum: 9007199254740991 base_revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - additions - deletions - base_revision additionalProperties: false observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false readiness: type: object properties: is_draft: anyOf: - type: object properties: status: enum: - available value: type: boolean observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false checks: anyOf: - type: object properties: status: enum: - available value: enum: - none - pending - passing - failing type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false conflicts: anyOf: - type: object properties: status: enum: - available value: enum: - clean - conflicted - outdated type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false provider_eligibility: anyOf: - type: object properties: status: enum: - available value: enum: - allowed - blocked type: string observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false required: - is_draft - checks - conflicts - provider_eligibility additionalProperties: false closure: type: object properties: closeability: anyOf: - type: object properties: status: enum: - available value: type: number minimum: 0 maximum: 1 observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false revival: anyOf: - type: object properties: status: enum: - available value: type: number minimum: 0 maximum: 1 observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false supersession: anyOf: - type: object properties: status: enum: - available value: type: object properties: reason: anyOf: - type: string - type: string nullable: true enum: - null expires_at: type: string format: date-time replacements: type: array items: type: object properties: external_id: type: string minLength: 1 url: anyOf: - type: string maxLength: 2048 format: uri - type: string nullable: true enum: - null required: - external_id - url additionalProperties: false required: - reason - expires_at - replacements additionalProperties: false observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false - type: object properties: status: enum: - unknown - stale - unsupported type: string value: type: string nullable: true enum: - null observed_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null revision: anyOf: - type: string minLength: 1 - type: string nullable: true enum: - null required: - status - value - observed_at - revision additionalProperties: false required: - closeability - revival - supersession additionalProperties: false required: - id - external_id - provider - provider_host - url - repository - title - state - author - head_revision - latest_commit_at - latest_reviewable_observed_at - opened_at - age_seconds - last_activity_at - last_human_activity_at - change_type - focus_state - priority - close_candidate - requires_attention - attention_reason_codes - next_action - review_status - approval_status - blast_radius - merge_risk - security_risk - review_effort - review_depth - participants - blocked_change_count - issue_severity - complexity - diff - readiness - closure additionalProperties: false meta: type: object properties: request_id: type: string minLength: 1 org_id: type: string minLength: 1 maxLength: 255 pattern: ^[^,\s/\p{Cc}]+$ generated_at: type: string format: date-time view: enum: - mine required: - request_id - org_id - generated_at - view additionalProperties: false required: - data - meta 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.