GitHub Copilot

APIs and resources for GitHub Copilot, an AI pair programmer that helps you write code faster.

12 APIs 10 Features

AgentsAIArtificial IntelligenceCode GenerationCode ReviewCoding AgentCustom InstructionsDeveloper ToolsExtensionsIDEMachine LearningMCPMetricsModel Context ProtocolProductivity

APIs

GitHub Copilot API

REST API for managing GitHub Copilot seats, usage, and organization settings.

GitHub Copilot for Business API

Manage Copilot for Business subscriptions, seat assignments, and usage metrics.

GitHub Copilot Chat API

API for GitHub Copilot Chat interactions and conversations.

GitHub Copilot User Management API

REST API for managing GitHub Copilot seat assignments, billing information, and subscription details for organizations including adding and removing users and teams.

GitHub Copilot Metrics API

REST API for retrieving aggregated Copilot usage metrics at the organization and team level, including data on active users, engaged users, and breakdowns by language and editor.

GitHub Copilot Usage Metrics API

REST API for retrieving detailed Copilot usage metrics reports at the enterprise and organization level, including daily and 28-day aggregated reports for both entity-level and ...

GitHub Copilot Content Exclusion API

REST API for programmatically managing Copilot content exclusion path rules at both the organization and enterprise level, enabling automation and governance of which content Co...

GitHub Copilot Extensions API

Platform for building Copilot Extensions that integrate third-party tools, services, and custom agents into GitHub Copilot Chat, using GitHub Apps with agent or skillset configu...

GitHub Copilot Coding Agent

Autonomous coding agent that works in the background to complete tasks, spinning up secure development environments powered by GitHub Actions to explore code, make changes, run ...

GitHub Copilot Code Review

AI-powered code review agent that analyzes pull requests for issues, suggests fixes, and provides feedback across any programming language with agentic context gathering capabil...

GitHub MCP Server

GitHub official Model Context Protocol server that enables AI tools to interact with GitHub repositories, issues, pull requests, and other resources through a standardized proto...

GitHub Copilot Custom Instructions

Configuration system for providing repository-level, path-specific, and organization-level custom instructions to guide Copilot behavior, code style, and response formatting.

Collections

GitHub Copilot REST API

POSTMAN

GitHub Copilot REST API

OPEN

Arazzo Workflows

GitHub Copilot Audit Seat Assignments

List all Copilot seat assignments for an organization and drill into the first seat's details.

ARAZZO

GitHub Copilot Deprovision Seats for Users

List current seats, set seats to pending cancellation for selected users, and confirm the updated billing breakdown.

ARAZZO

GitHub Copilot Enterprise Metrics Report

Fetch the latest 28-day enterprise usage report, then the daily enterprise and user-level usage reports for a specific day.

ARAZZO

GitHub Copilot Organization Metrics Report

Pull aggregated organization Copilot metrics, then fetch the latest 28-day org and user-level usage report links.

ARAZZO

GitHub Copilot Provision Seats for Teams

Confirm organization billing capacity, assign Copilot seats to whole teams, and read back the updated seat breakdown.

ARAZZO

GitHub Copilot Provision Seats for Users

Check organization billing capacity, assign Copilot seats to selected users, and verify a seat was granted.

ARAZZO

GitHub Copilot Team Metrics Report

Pull organization-wide Copilot metrics, then drill into a specific team's aggregated metrics.

ARAZZO

Pricing Plans

Github Copilot Plans Pricing

5 plans

PLANS

Rate Limits

Github Copilot Rate Limits

11 limits

RATE LIMITS

FinOps

Github Copilot Finops

FINOPS

Features

Code Completion

AI-powered inline code suggestions that complete lines, functions, and entire blocks as you type in your IDE.

Chat

Conversational AI assistant for asking questions about code, generating solutions, and debugging directly in your editor.

Coding Agent

Autonomous agent that explores code, makes changes, runs tests, and opens pull requests from issue assignments.

Code Review

AI-powered pull request review that analyzes changes, identifies issues, and suggests fixes across any language.

Extensions

Third-party integrations that extend Copilot Chat with custom tools, services, and domain-specific agents.

Custom Instructions

Repository-level and organization-level configuration to guide Copilot behavior, code style, and conventions.

MCP Server

Model Context Protocol server enabling AI tools to interact with GitHub repositories, issues, and pull requests.

Content Exclusion

Governance controls to specify which files and repositories Copilot can access at organization and enterprise level.

Usage Metrics

Detailed analytics on Copilot adoption, usage patterns, and productivity impact across organizations and enterprises.

Seat Management

Programmatic management of Copilot seat assignments, billing, and subscription details for organizations and teams.

Use Cases

Developer Productivity

Accelerate software development with AI-powered code completions, chat assistance, and automated code review.

Enterprise Copilot Governance

Manage Copilot deployments at scale with seat management, content exclusion, usage metrics, and compliance controls.

Custom AI Tooling

Build domain-specific Copilot Extensions and agents that integrate third-party tools and services into the developer workflow.

Code Quality Automation

Automate code review, identify potential issues, and enforce coding standards using the Copilot Code Review agent.

Integrations

Visual Studio Code

Full Copilot integration in VS Code including code completion, chat, code review, and MCP support.

JetBrains IDEs

Copilot code completion and chat support across IntelliJ, PyCharm, WebStorm, and other JetBrains IDEs.

GitHub.com

Copilot Chat, code review, and coding agent capabilities directly in the GitHub web interface.

GitHub Actions

Copilot coding agent uses GitHub Actions to spin up secure environments for autonomous coding tasks.

Model Context Protocol

Standard protocol integration enabling AI tools to access GitHub data through the official MCP server.

Semantic Vocabularies

Github Copilot Context

0 classes · 0 properties

JSON-LD

API Governance Rules

GitHub Copilot API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Github Copilot Code Completions Editor Structure

3 properties

JSON STRUCTURE

Github Copilot Code Completions Language Metrics Structure

6 properties

JSON STRUCTURE

Github Copilot Code Completions Model Structure

5 properties

JSON STRUCTURE

Github Copilot Content Exclusion Rules Structure

0 properties

JSON STRUCTURE

Github Copilot Copilot Billing Info Structure

6 properties

JSON STRUCTURE

Github Copilot Copilot Dotcom Chat Structure

2 properties

JSON STRUCTURE

Github Copilot Copilot Dotcom Pull Requests Structure

2 properties

JSON STRUCTURE

Github Copilot Copilot Ide Chat Structure

2 properties

JSON STRUCTURE

Github Copilot Copilot Ide Code Completions Structure

3 properties

JSON STRUCTURE

Github Copilot Copilot Metrics Day Structure

7 properties

JSON STRUCTURE

Github Copilot Copilot Seat Detail Structure

9 properties

JSON STRUCTURE

Github Copilot Copilot Seats Response Structure

2 properties

JSON STRUCTURE

Github Copilot Dotcom Chat Model Structure

5 properties

JSON STRUCTURE

Github Copilot Error Structure

2 properties

JSON STRUCTURE

Github Copilot Ide Chat Editor Structure

3 properties

JSON STRUCTURE

Github Copilot Ide Chat Model Structure

7 properties

JSON STRUCTURE

Github Copilot Metrics Language Summary Structure

2 properties

JSON STRUCTURE

Github Copilot Pull Request Model Structure

5 properties

JSON STRUCTURE

Github Copilot Pull Request Repository Structure

3 properties

JSON STRUCTURE

Github Copilot Seat Breakdown Structure

6 properties

JSON STRUCTURE

Github Copilot Seats Cancelled Response Structure

1 properties

JSON STRUCTURE

Github Copilot Seats Created Response Structure

1 properties

JSON STRUCTURE

Github Copilot Selected Teams Request Structure

1 properties

JSON STRUCTURE

Github Copilot Selected Users Request Structure

1 properties

JSON STRUCTURE

Github Copilot Simple User Structure

18 properties

JSON STRUCTURE

Github Copilot Structure

0 properties

JSON STRUCTURE

Github Copilot Team Structure

12 properties

JSON STRUCTURE

Github Copilot Usage Report Daily Structure

2 properties

JSON STRUCTURE

Github Copilot Usage Report28 Day Structure

3 properties

JSON STRUCTURE

Example Payloads

Github Copilot Addteamstocopilotsubscription Example

6 fields

EXAMPLE

Github Copilot Adduserstocopilotsubscription Example

6 fields

EXAMPLE

Github Copilot Code Completions Editor Example

3 fields

EXAMPLE

Github Copilot Code Completions Language Metrics Example

6 fields

EXAMPLE

Github Copilot Code Completions Model Example

5 fields

EXAMPLE

Github Copilot Content Exclusion Rules Example

EXAMPLE

Github Copilot Copilot Billing Info Example

6 fields

EXAMPLE

Github Copilot Copilot Dotcom Chat Example

2 fields

EXAMPLE

Github Copilot Copilot Dotcom Pull Requests Example

2 fields

EXAMPLE

Github Copilot Copilot Ide Chat Example

2 fields

EXAMPLE

Github Copilot Copilot Ide Code Completions Example

3 fields

EXAMPLE

Github Copilot Copilot Metrics Day Example

7 fields

EXAMPLE

Github Copilot Copilot Seat Detail Example

9 fields

EXAMPLE

Github Copilot Copilot Seats Response Example

2 fields

EXAMPLE

Github Copilot Dotcom Chat Model Example

5 fields

EXAMPLE

Github Copilot Error Example

2 fields

EXAMPLE

Github Copilot Getcopilotbillingfororganization Example

6 fields

EXAMPLE

Github Copilot Getcopilotcontentexclusionrules Example

6 fields

EXAMPLE

Github Copilot Getcopilotmetricsfororganization Example

6 fields

EXAMPLE

Github Copilot Getcopilotmetricsforteam Example

6 fields

EXAMPLE

Github Copilot Getcopilotseatforuser Example

6 fields

EXAMPLE

Github Copilot Getenterprisecopilotusage28Day Example

6 fields

EXAMPLE

Github Copilot Getenterprisecopilotusagedaily Example

6 fields

EXAMPLE

Github Copilot Getenterpriseuserscopilotusage28Day Example

6 fields

EXAMPLE

Github Copilot Getenterpriseuserscopilotusagedaily Example

6 fields

EXAMPLE

Github Copilot Getorganizationcopilotusage28Day Example

6 fields

EXAMPLE

Github Copilot Getorganizationcopilotusagedaily Example

6 fields

EXAMPLE

Github Copilot Getorganizationuserscopilotusage28Day Example

6 fields

EXAMPLE

Github Copilot Getorganizationuserscopilotusagedaily Example

6 fields

EXAMPLE

Github Copilot Ide Chat Editor Example

3 fields

EXAMPLE

Github Copilot Ide Chat Model Example

7 fields

EXAMPLE

Github Copilot Listcopilotseats Example

6 fields

EXAMPLE

Github Copilot Metrics Language Summary Example

2 fields

EXAMPLE

Github Copilot Pull Request Model Example

5 fields

EXAMPLE

Github Copilot Pull Request Repository Example

3 fields

EXAMPLE

Github Copilot Removeteamsfromcopilotsubscription Example

6 fields

EXAMPLE

Github Copilot Removeusersfromcopilotsubscription Example

6 fields

EXAMPLE

Github Copilot Seat Breakdown Example

6 fields

EXAMPLE

Github Copilot Seats Cancelled Response Example

1 fields

EXAMPLE

Github Copilot Seats Created Response Example

1 fields

EXAMPLE

Github Copilot Selected Teams Request Example

1 fields

EXAMPLE

Github Copilot Selected Users Request Example

1 fields

EXAMPLE

Github Copilot Setcopilotcontentexclusionrules Example

6 fields

EXAMPLE

Github Copilot Simple User Example

18 fields

EXAMPLE

Github Copilot Team Example

12 fields

EXAMPLE

Github Copilot Usage Report Daily Example

2 fields

EXAMPLE

Github Copilot Usage Report28 Day Example

3 fields

EXAMPLE

Resources

Sources

opencollection: 1.0.0
info:
  name: GitHub Copilot REST API
  version: 1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Copilot Billing
    type: folder
  items:
  - info:
      name: Github Copilot Get Copilot Billing Information for an Organization
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/billing
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
    docs: Retrieves subscription details including seat breakdown and feature policies for an organization's Copilot subscription.
      Only organization owners can access this endpoint.
- info:
    name: Copilot Seats
    type: folder
  items:
  - info:
      name: Github Copilot List All Copilot Seat Assignments for an Organization
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/billing/seats
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      - name: page
        value: ''
        type: query
        description: The page number of results to fetch.
      - name: per_page
        value: ''
        type: query
        description: The number of results per page (max 100).
    docs: Enumerates all active Copilot seats for which an organization is currently billed, including user activity metrics
      such as last activity date, editor, and authentication timestamp.
  - info:
      name: Github Copilot Get Copilot Seat Assignment Details for a User
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/members/:username/copilot
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      - name: username
        value: octocat
        type: path
        description: The handle for the GitHub user account.
    docs: Retrieves comprehensive seat assignment information for a specific organization member, including usage patterns,
      last activity, and assignment origin.
- info:
    name: Copilot User Management
    type: folder
  items:
  - info:
      name: Github Copilot Add Teams to Copilot Subscription
      type: http
    http:
      method: POST
      url: https://api.github.com/orgs/:org/copilot/billing/selected_teams
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      body:
        type: json
        data: '{}'
    docs: Purchases Copilot seats for all members within designated teams. Billing is based on the organization's Copilot
      plan. Only organization owners can call this endpoint.
  - info:
      name: Github Copilot Remove Teams From Copilot Subscription
      type: http
    http:
      method: DELETE
      url: https://api.github.com/orgs/:org/copilot/billing/selected_teams
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      body:
        type: json
        data: '{}'
    docs: Marks seats for all members of specified teams as pending cancellation. Access ends at the conclusion of the current
      billing cycle.
  - info:
      name: Github Copilot Add Users to Copilot Subscription
      type: http
    http:
      method: POST
      url: https://api.github.com/orgs/:org/copilot/billing/selected_users
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      body:
        type: json
        data: '{}'
    docs: Provisions Copilot seats for specified individual organization members. Charges are applied per the organization's
      plan structure.
  - info:
      name: Github Copilot Remove Users From Copilot Subscription
      type: http
    http:
      method: DELETE
      url: https://api.github.com/orgs/:org/copilot/billing/selected_users
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      body:
        type: json
        data: '{}'
    docs: Sets user seats to pending cancellation, revoking access at the end of the billing cycle unless the user is retained
      through a team assignment.
- info:
    name: Copilot Metrics
    type: folder
  items:
  - info:
      name: Github Copilot Get Copilot Metrics for an Organization
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/metrics
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      - name: since
        value: ''
        type: query
        description: Show usage metrics since this date (ISO 8601 format YYYY-MM-DD). Maximum 100 days in the past.
      - name: until
        value: ''
        type: query
        description: Show usage metrics until this date (ISO 8601 format YYYY-MM-DD).
      - name: page
        value: ''
        type: query
        description: The page number of results to fetch.
      - name: per_page
        value: ''
        type: query
        description: Number of days of metrics per page (max 100).
    docs: Retrieves aggregated metrics for various GitHub Copilot features broken down by language and IDE editor. Requires
      at least five organization members with active Copilot licenses. Data reflects previous day metrics only.
  - info:
      name: Github Copilot Get Copilot Metrics for a Team
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/team/:team_slug/copilot/metrics
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      - name: team_slug
        value: engineering
        type: path
        description: The slug of the team name.
      - name: since
        value: ''
        type: query
        description: Show usage metrics since this date (ISO 8601 format YYYY-MM-DD). Maximum 100 days in the past.
      - name: until
        value: ''
        type: query
        description: Show usage metrics until this date (ISO 8601 format YYYY-MM-DD).
      - name: page
        value: ''
        type: query
        description: The page number of results to fetch.
      - name: per_page
        value: ''
        type: query
        description: Number of days of metrics per page (max 100).
    docs: Retrieves aggregated Copilot metrics for a specific team within an organization, broken down by language and IDE
      editor. Requires at least five team members with active Copilot licenses.
- info:
    name: Copilot Usage Reports
    type: folder
  items:
  - info:
      name: Github Copilot Get Enterprise Copilot Usage Metrics for a Specific Day
      type: http
    http:
      method: GET
      url: https://api.github.com/enterprises/:enterprise/copilot/metrics/reports/enterprise-1-day
      params:
      - name: enterprise
        value: octo-enterprise
        type: path
        description: The slug version of the enterprise name.
      - name: day
        value: ''
        type: query
        description: The date for the report in YYYY-MM-DD format.
    docs: Retrieves download links for daily enterprise-level Copilot usage metrics reports. Reports are generated daily and
      data is available from October 10, 2025, extending back up to one year historically.
  - info:
      name: Github Copilot Get Latest 28-day Enterprise Copilot Usage Metrics
      type: http
    http:
      method: GET
      url: https://api.github.com/enterprises/:enterprise/copilot/metrics/reports/enterprise-28-day/latest
      params:
      - name: enterprise
        value: octo-enterprise
        type: path
        description: The slug version of the enterprise name.
    docs: Retrieves download links for the latest 28-day enterprise-level Copilot usage metrics report.
  - info:
      name: Github Copilot Get Enterprise User-level Copilot Usage Metrics for a Specific Day
      type: http
    http:
      method: GET
      url: https://api.github.com/enterprises/:enterprise/copilot/metrics/reports/users-1-day
      params:
      - name: enterprise
        value: octo-enterprise
        type: path
        description: The slug version of the enterprise name.
      - name: day
        value: ''
        type: query
        description: The date for the report in YYYY-MM-DD format.
    docs: Retrieves download links for daily user-level Copilot usage metrics reports at the enterprise level, providing individual
      user engagement statistics, feature usage patterns, and adoption metrics.
  - info:
      name: Github Copilot Get Latest 28-day Enterprise User-level Copilot Usage Metrics
      type: http
    http:
      method: GET
      url: https://api.github.com/enterprises/:enterprise/copilot/metrics/reports/users-28-day/latest
      params:
      - name: enterprise
        value: octo-enterprise
        type: path
        description: The slug version of the enterprise name.
    docs: Retrieves download links for the latest 28-day user-level Copilot usage metrics report at the enterprise level.
  - info:
      name: Github Copilot Get Organization Copilot Usage Metrics for a Specific Day
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/metrics/reports/organization-1-day
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      - name: day
        value: ''
        type: query
        description: The date for the report in YYYY-MM-DD format.
    docs: Retrieves download links for daily organization-level Copilot usage metrics reports.
  - info:
      name: Github Copilot Get Latest 28-day Organization Copilot Usage Metrics
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/metrics/reports/organization-28-day/latest
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
    docs: Retrieves download links for the latest 28-day organization-level Copilot usage metrics report.
  - info:
      name: Github Copilot Get Organization User-level Copilot Usage Metrics for a Specific Day
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/metrics/reports/users-1-day
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      - name: day
        value: ''
        type: query
        description: The date for the report in YYYY-MM-DD format.
    docs: Retrieves download links for daily user-level Copilot usage metrics reports at the organization level.
  - info:
      name: Github Copilot Get Latest 28-day Organization User-level Copilot Usage Metrics
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/metrics/reports/users-28-day/latest
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
    docs: Retrieves download links for the latest 28-day user-level Copilot usage metrics report at the organization level.
- info:
    name: Copilot Content Exclusion
    type: folder
  items:
  - info:
      name: Github Copilot Get Copilot Content Exclusion Rules for an Organization
      type: http
    http:
      method: GET
      url: https://api.github.com/orgs/:org/copilot/content_exclusion
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
    docs: Gets information about an organization's Copilot content exclusion path rules. These rules define which files and
      directories Copilot is prevented from accessing.
  - info:
      name: Github Copilot Set Copilot Content Exclusion Rules for an Organization
      type: http
    http:
      method: PUT
      url: https://api.github.com/orgs/:org/copilot/content_exclusion
      params:
      - name: org
        value: octo-org
        type: path
        description: The organization name. Case-insensitive.
      body:
        type: json
        data: '{}'
    docs: Sets Copilot content exclusion path rules for an organization. Replaces existing rules with the provided set.
bundled: true