{"openapi":"3.1.0","info":{"title":"GitHub Copilot (BYOK) API","version":"0.1.0","description":"GitHub Copilot (BYOK) lets an AI assistant read your own GitHub Copilot data through the GitHub Copilot API with a key you supply (GitHub personal access token of an organization owner (manage_billing:copilot or read:org scope, plus the Copilot metrics scope for reports)). Read-only: 10 tools (get_copilot_billing, list_copilot_seats, get_user_copilot_seat, get_cloud_agent_permissions,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-github-copilot.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-github-copilot/docs"},"termsOfService":"https://connectorbay.com/byok-github-copilot/terms"},"servers":[{"url":"https://byok-github-copilot.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-github-copilot/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_copilot_billing":{"post":{"operationId":"get_copilot_billing","summary":"Get an organization's Copilot plan, seat counts (total, active, inactive, pending) and feature settings such as IDE chat","description":"Get an organization's Copilot plan, seat counts (total, active, inactive, pending) and feature settings such as IDE chat, platform chat and CLI. Use for \"How many Copilot seats does octo-org use and how many are inactive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"}},"required":["org"],"title":"get_copilot_billingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_copilot_seats":{"post":{"operationId":"list_copilot_seats","summary":"List the Copilot seat assignments of an organization with assignee login, last activity, last editor and any pending can","description":"List the Copilot seat assignments of an organization with assignee login, last activity, last editor and any pending cancellation date. Use for \"Which octo-org members have not used Copilot recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many seats to return (1 to 100, default 50).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["org"],"title":"list_copilot_seatsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_user_copilot_seat":{"post":{"operationId":"get_user_copilot_seat","summary":"Get the Copilot seat details of one organization member: last activity, editor, plan and assigning team. Use for \"Does o","description":"Get the Copilot seat details of one organization member: last activity, editor, plan and assigning team. Use for \"Does octocat have a Copilot seat in octo-org and when was it last used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"username":{"description":"GitHub login of the organization member.","maxLength":200,"title":"Username","type":"string"}},"required":["org","username"],"title":"get_user_copilot_seatArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_cloud_agent_permissions":{"post":{"operationId":"get_cloud_agent_permissions","summary":"Show which repositories of an organization may use the Copilot cloud agent: all, selected or none. Use for \"Is the Copil","description":"Show which repositories of an organization may use the Copilot cloud agent: all, selected or none. Use for \"Is the Copilot cloud agent enabled for octo-org\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"}},"required":["org"],"title":"get_cloud_agent_permissionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_cloud_agent_repositories":{"post":{"operationId":"list_cloud_agent_repositories","summary":"List the repositories enabled for the Copilot cloud agent when the organization uses a selected set. Use for \"Which octo","description":"List the repositories enabled for the Copilot cloud agent when the organization uses a selected set. Use for \"Which octo-org repositories have the Copilot cloud agent enabled\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["org"],"title":"list_cloud_agent_repositoriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_repository_cloud_agent_config":{"post":{"operationId":"get_repository_cloud_agent_config","summary":"Get a repository's Copilot cloud agent configuration: enabled tools, firewall state and approval requirements. Use for \"","description":"Get a repository's Copilot cloud agent configuration: enabled tools, firewall state and approval requirements. Use for \"How is the Copilot cloud agent configured in octo-org/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name.","maxLength":200,"title":"Repo","type":"string"}},"required":["owner","repo"],"title":"get_repository_cloud_agent_configArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_org_usage_report_28_day":{"post":{"operationId":"get_org_usage_report_28_day","summary":"Get download links and the date range of the latest 28-day Copilot usage report for an organization. Use for \"Where can ","description":"Get download links and the date range of the latest 28-day Copilot usage report for an organization. Use for \"Where can I download the latest 28-day Copilot usage report for octo-org\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"}},"required":["org"],"title":"get_org_usage_report_28_dayArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_org_usage_report_for_day":{"post":{"operationId":"get_org_usage_report_for_day","summary":"Get download links of the organization-wide Copilot usage report for one day. Use for \"Where is the octo-org Copilot usa","description":"Get download links of the organization-wide Copilot usage report for one day. Use for \"Where is the octo-org Copilot usage report for 2026-10-10\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"day":{"description":"The report day as YYYY-MM-DD, for example 2026-10-10.","maxLength":10,"title":"Day","type":"string"}},"required":["org","day"],"title":"get_org_usage_report_for_dayArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_org_users_report_28_day":{"post":{"operationId":"get_org_users_report_28_day","summary":"Get download links and date range of the latest 28-day per-user Copilot usage report for an organization. Use for \"Where","description":"Get download links and date range of the latest 28-day per-user Copilot usage report for an organization. Use for \"Where can I download per-user Copilot usage for octo-org over the last 28 days\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"}},"required":["org"],"title":"get_org_users_report_28_dayArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_org_repos_report_for_day":{"post":{"operationId":"get_org_repos_report_for_day","summary":"Get download links of the per-repository Copilot usage report of an organization for one day. Use for \"Where is the octo","description":"Get download links of the per-repository Copilot usage report of an organization for one day. Use for \"Where is the octo-org Copilot report by repository for 2026-10-10\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"day":{"description":"The report day as YYYY-MM-DD, for example 2026-10-10.","maxLength":10,"title":"Day","type":"string"}},"required":["org","day"],"title":"get_org_repos_report_for_dayArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}