Copilot

Reference documentation for GraphQL schema types in the Copilot category.

In this article

Mutations

updateEnterpriseCopilotCodeReviewPolicy

Mutation

Updates an enterprise's Copilot code review policy using the existing policy propagation and notification behavior.

Input fields for updateEnterpriseCopilotCodeReviewPolicy

Return fields for updateEnterpriseCopilotCodeReviewPolicy

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

policy (EnterpriseCopilotCodeReviewPolicy)

The updated enterprise policy.

updateOrganizationCopilotCodeReviewPolicy

Mutation

Updates an organization's Copilot code review policy when the enterprise delegates control to organization administrators.

Input fields for updateOrganizationCopilotCodeReviewPolicy

Return fields for updateOrganizationCopilotCodeReviewPolicy

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

conflict (OrganizationCopilotCodeReviewPolicyConflict)

Why the policy was not updated. Null if the update succeeded.

policy (OrganizationCopilotCodeReviewPolicy)

The organization's current policy.

updateOrganizationCopilotCodeReviewRunnerConfiguration

Mutation

Sets the runner configuration that Copilot code review uses for an organization. A LABELED runner requires at least one label or a runner group. Invalid input does not change the configuration.

Input fields for updateOrganizationCopilotCodeReviewRunnerConfiguration

Return fields for updateOrganizationCopilotCodeReviewRunnerConfiguration

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

runnerConfiguration (OrganizationCopilotCodeReviewRunnerConfiguration)

The organization's updated runner configuration.

updateOrganizationCopilotCodeReviewSettings

Mutation

Updates an organization's Copilot code review settings. Omitted settings are not changed.

Input fields for updateOrganizationCopilotCodeReviewSettings

Return fields for updateOrganizationCopilotCodeReviewSettings

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

conflict (OrganizationCopilotCodeReviewSettingsConflict)

Why the settings were not updated. Null if the update succeeded.

settings (OrganizationCopilotCodeReviewSettings)

The organization's current settings.

updateRepositoryCopilotCodeReviewSettings

Mutation

Updates a repository's Copilot code review settings. Omitted settings are not changed.

Input fields for updateRepositoryCopilotCodeReviewSettings

Return fields for updateRepositoryCopilotCodeReviewSettings

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

settings (RepositoryCopilotCodeReviewSettings)

The repository's current settings.

Objects

CopilotEndpoints

Object

Copilot endpoint information.

Fields for CopilotEndpoints

NameDescription

api (String!)

Copilot API endpoint.

exp (String)

Copilot experimentation (edge TAS) endpoint.

originTracker (String!)

Copilot origin tracker endpoint.

proxy (String!)

Copilot proxy endpoint.

telemetry (String!)

Copilot telemetry endpoint.

EnterpriseCopilotCodeReviewPolicy

Object

The enterprise's configured Copilot code review policy, not a user's effective policy.

Fields for EnterpriseCopilotCodeReviewPolicy

NameDescription

policyState (EnterpriseCopilotCodeReviewPolicyState)

The configured policy. Null if the enterprise has not configured a policy.

OrganizationCopilotCodeReviewDefaultEffort

Object

An organization's default Copilot code review effort.

Fields for OrganizationCopilotCodeReviewDefaultEffort

NameDescription

configured (CopilotCodeReviewEffortLevel)

The effort stored for the organization. Null if the organization inherits the default or has stored an effort that is not currently available.

editable (Boolean!)

Whether organization administrators can update the setting.

effective (CopilotCodeReviewEffortLevel!)

The effort that repositories without their own setting use. When that effort is not currently available, this reports the fallback effort instead.

githubDefault (CopilotCodeReviewEffortLevel!)

The effort the organization inherits when it does not configure one: the enterprise default when one applies, otherwise GitHub's default.

managedBy (OrganizationCopilotCodeReviewPolicyManager!)

Whether the enterprise or the organization controls the setting.

OrganizationCopilotCodeReviewPolicy

Object

The organization's configured and effective Copilot code review policy.

Fields for OrganizationCopilotCodeReviewPolicy

NameDescription

configuredState (OrganizationCopilotCodeReviewPolicyState)

The policy stored for the organization. Null if the organization has not configured a policy.

editable (Boolean!)

Whether organization administrators can update the policy.

effectiveState (OrganizationCopilotCodeReviewPolicyState!)

The policy that applies to the organization after enterprise policy is considered.

managedBy (OrganizationCopilotCodeReviewPolicyManager!)

Whether the enterprise or the organization controls the policy.

OrganizationCopilotCodeReviewRunnerConfiguration

Object

The effective runner configuration that Copilot code review uses for an organization.

Fields for OrganizationCopilotCodeReviewRunnerConfiguration

NameDescription

allowRepositoryCustomization (Boolean!)

Whether repositories can use their own runner configuration.

configuredBy (CopilotCodeReviewRunnerConfiguredBy!)

Which configuration the values come from. CODING_AGENT means they are inherited from the organization's Copilot coding agent runner configuration.

runnerGroupName (String)

The runner group used for a labeled runner, if any.

runnerLabels ([String!]!)

The runner labels used for a labeled runner.

runnerType (CopilotCodeReviewRunnerType!)

The type of runner.

OrganizationCopilotCodeReviewSettings

Object

An organization's Copilot code review settings.

Fields for OrganizationCopilotCodeReviewSettings

NameDescription

availableReviewEfforts ([CopilotCodeReviewEffortLevel!]!)

The review efforts that can currently be set for this organization, in display order.

defaultReviewEffort (OrganizationCopilotCodeReviewDefaultEffort!)

The default review effort for repositories that do not choose their own.

RepositoryCopilotCodeReviewEffort

Object

A repository's Copilot code review effort.

Fields for RepositoryCopilotCodeReviewEffort

NameDescription

configured (CopilotCodeReviewEffortLevel)

The effort stored for the repository. Null if the repository inherits its effort or has stored an effort that is not currently available.

effective (CopilotCodeReviewEffortLevel!)

The effort reviews use when the requester and the pull request do not choose one. When that effort is not currently available, this reports the effort reviews would use without it.

RepositoryCopilotCodeReviewSettings

Object

A repository's Copilot code review settings. These settings tune reviews; they do not enable Copilot code review.

Fields for RepositoryCopilotCodeReviewSettings

NameDescription

availableReviewEfforts ([CopilotCodeReviewEffortLevel!]!)

The review efforts that can currently be set for this repository, in display order.

customInstructionsEnabled (Boolean!)

Whether reviews use the repository's custom instructions.

mcpEnabled (Boolean!)

Whether reviews can use MCP servers.

reviewEffort (RepositoryCopilotCodeReviewEffort!)

The repository's review effort.

severityFilter (CopilotCodeReviewSeverityFilter!)

Which review comment severities Copilot code review leaves out.

Interfaces

Agentic

Interface

Copilot Agentic fields in context of the current viewer.

Agentic is implemented by

Fields for Agentic

NameDescription

viewerCopilotAgentCreatesChannel (String)

Channel value for subscribing to live updates for session creations.

viewerCopilotAgentLogUpdatesChannel (String)

Channel value for subscribing to live updates for session log updates.

viewerCopilotAgentTaskUpdatesChannel (String)

Channel value for subscribing to live updates for task updates.

viewerCopilotAgentUpdatesChannel (String)

Channel value for subscribing to live updates for session updates.

Enums

CopilotCodeReviewEffort

Enum

The effort level for a Copilot code review. For more information, see Review effort level.

Values for CopilotCodeReviewEffort

NameDescription
AUTO

Copilot picks the effort for each pull request.

BALANCED

Balanced effort and depth.

LITE

Lower effort, faster review.

MAX

Highest effort, deepest review.

CopilotCodeReviewEffortLevel

Enum

A Copilot code review effort level. For more information, see Review effort level.

Values for CopilotCodeReviewEffortLevel

NameDescription
AUTO

Copilot picks the effort for each pull request.

BALANCED

Balanced effort and depth.

LITE

Lower effort, faster review.

MAX

Highest effort, deepest review.

CopilotCodeReviewRequestReason

Enum

The stable reason a Copilot code review request was denied or conflicted with an existing request.

Values for CopilotCodeReviewRequestReason

NameDescription
ACTOR_INELIGIBLE

The actor is not eligible to request Copilot code reviews.

APP_NOT_INSTALLED

The Copilot code review reviewer app is not installed.

LICENSED_ORGANIZATION_UNAVAILABLE

The organization providing the Copilot license is unavailable.

NO_QUOTA_REMAINING

The actor has no Copilot code review quota remaining.

REPOSITORY_INELIGIBLE

The repository is not eligible for Copilot code reviews.

REQUEST_CONFLICT

A Copilot code review request is already pending for this pull request.

CopilotCodeReviewRunnerConfiguredBy

Enum

Which configuration an organization's Copilot code review runner values come from.

Values for CopilotCodeReviewRunnerConfiguredBy

NameDescription
CODE_REVIEW

The organization has saved a Copilot code review runner configuration.

CODING_AGENT

The values are inherited from the organization's Copilot coding agent runner configuration.

CopilotCodeReviewRunnerType

Enum

The type of runner Copilot code review uses.

Values for CopilotCodeReviewRunnerType

NameDescription
LABELED

Runners that match the configured labels or runner group.

STANDARD

Standard GitHub-hosted runners.

CopilotCodeReviewSeverityFilter

Enum

Which review comment severities Copilot code review leaves out.

Values for CopilotCodeReviewSeverityFilter

NameDescription
LOW

Leave out low-severity comments.

LOW_AND_MEDIUM

Leave out low- and medium-severity comments.

NO_FILTER

Keep every comment.

EnterpriseCopilotCodeReviewPolicyState

Enum

The configured Copilot code review policy for an enterprise.

Values for EnterpriseCopilotCodeReviewPolicyState

NameDescription
CONFIGURED_BY_ORGANIZATION_ADMINS

Organization administrators configure Copilot code review. Not supported for standalone enterprises.

DISABLED_FOR_ALL_ORGANIZATIONS

Copilot code review is disabled for all organizations.

ENABLED_FOR_ALL_ORGANIZATIONS

Copilot code review is enabled for all organizations.

OrganizationCopilotCodeReviewEffortSetting

Enum

The default Copilot code review effort to set for an organization. For more information, see Review effort level.

Values for OrganizationCopilotCodeReviewEffortSetting

NameDescription
AUTO

Copilot picks the effort for each pull request.

BALANCED

Balanced effort and depth.

INHERIT

Clear the organization's value so repositories inherit the default.

LITE

Lower effort, faster review.

MAX

Highest effort, deepest review.

OrganizationCopilotCodeReviewPolicyConflict

Enum

Why an organization's Copilot code review policy was not updated.

Values for OrganizationCopilotCodeReviewPolicyConflict

NameDescription
POLICY_MANAGED_BY_ENTERPRISE

The enterprise policy controls the organization's policy.

OrganizationCopilotCodeReviewPolicyManager

Enum

The scope that controls an organization's Copilot code review policy.

Values for OrganizationCopilotCodeReviewPolicyManager

NameDescription
ENTERPRISE

The enterprise policy controls the organization's policy.

ORGANIZATION

Organization administrators control the policy.

OrganizationCopilotCodeReviewPolicyState

Enum

The Copilot code review policy state for an organization.

Values for OrganizationCopilotCodeReviewPolicyState

NameDescription
DISABLED

Copilot code review is disabled.

ENABLED

Copilot code review is enabled.

OrganizationCopilotCodeReviewSettingsConflict

Enum

Why an organization's Copilot code review settings were not updated.

Values for OrganizationCopilotCodeReviewSettingsConflict

NameDescription
SETTING_NOT_EDITABLE

The organization cannot change a submitted setting.

RepositoryCopilotCodeReviewEffortSetting

Enum

The Copilot code review effort to set for a repository. For more information, see Review effort level.

Values for RepositoryCopilotCodeReviewEffortSetting

NameDescription
AUTO

Copilot picks the effort for each pull request.

BALANCED

Balanced effort and depth.

INHERIT

Clear the repository's value so it inherits the effort from its organization, enterprise, or GitHub's default.

LITE

Lower effort, faster review.

MAX

Highest effort, deepest review.

Input objects

UpdateEnterpriseCopilotCodeReviewPolicyInput

Input object

Autogenerated input type of UpdateEnterpriseCopilotCodeReviewPolicy.

Input fields for UpdateEnterpriseCopilotCodeReviewPolicyInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise whose policy to update.

policyState (EnterpriseCopilotCodeReviewPolicyState!)

The policy to set. Standalone enterprises cannot delegate to organization administrators.

UpdateOrganizationCopilotCodeReviewPolicyInput

Input object

Autogenerated input type of UpdateOrganizationCopilotCodeReviewPolicy.

Input fields for UpdateOrganizationCopilotCodeReviewPolicyInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization whose policy to update.

state (OrganizationCopilotCodeReviewPolicyState!)

The policy to set.

UpdateOrganizationCopilotCodeReviewRunnerConfigurationInput

Input object

Autogenerated input type of UpdateOrganizationCopilotCodeReviewRunnerConfiguration.

Input fields for UpdateOrganizationCopilotCodeReviewRunnerConfigurationInput

NameDescription

allowRepositoryCustomization (Boolean)

Whether repositories can use their own runner configuration. When omitted, the current effective value is kept.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization whose runner configuration to set.

runnerGroupName (String)

The runner group for a labeled runner.

runnerLabels ([String!])

The runner labels for a labeled runner.

runnerType (CopilotCodeReviewRunnerType!)

The type of runner.

UpdateOrganizationCopilotCodeReviewSettingsInput

Input object

Autogenerated input type of UpdateOrganizationCopilotCodeReviewSettings.

Input fields for UpdateOrganizationCopilotCodeReviewSettingsInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

defaultReviewEffort (OrganizationCopilotCodeReviewEffortSetting)

The default review effort for repositories that do not choose their own. INHERIT clears the organization's value.

organizationId (ID!)

The ID of the organization whose settings to update.

UpdateRepositoryCopilotCodeReviewSettingsInput

Input object

Autogenerated input type of UpdateRepositoryCopilotCodeReviewSettings.

Input fields for UpdateRepositoryCopilotCodeReviewSettingsInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

customInstructionsEnabled (Boolean)

Whether reviews use the repository's custom instructions.

mcpEnabled (Boolean)

Whether reviews can use MCP servers.

repositoryId (ID!)

The ID of the repository whose settings to update.

reviewEffort (RepositoryCopilotCodeReviewEffortSetting)

The review effort for the repository. INHERIT clears the repository's value.

severityFilter (CopilotCodeReviewSeverityFilter)

Which review comment severities Copilot code review leaves out.