Draft
Add API request reference docs: request/response architecture, clientName, x-github-request-id#1
Conversation
…ody format, and authentication flow Co-authored-by: Mouseww <28473201+Mouseww@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Analyze request body and headers for Copilot interface
Add API request reference documentation
Mar 11, 2026
…ws, all-language examples, and providerCallId vs requestId disambiguation Co-authored-by: Mouseww <28473201+Mouseww@users.noreply.github.com>
…ify requestId in compaction events Co-authored-by: Mouseww <28473201+Mouseww@users.noreply.github.com>
Copilot
AI
changed the title
Add API request reference documentation
Add API request reference docs: request/response architecture, clientName, x-github-request-id
Mar 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents how the SDK communicates with the Copilot API via the CLI, with deep dives on
clientNameandx-github-request-id.New:
docs/api-request-reference.mdapi.githubcopilot.comflow with diagramsclientName: Data flow diagram, examples in all 4 languages for create/resume, JSON-RPC payload format, best practicesx-github-request-id: Response header → SDK event field mapping, distinguishesproviderCallId(from API header, for GitHub support debugging) vsrequestId(CLI-internal, for tool/permission round-trips)/chat/completionsbody, streaming SSE, BYOK provider differencesproviderCallIdfor support correlationKey disambiguation —
requestIdhas two meanings:session.error,session.usage_info→providerCallIdx-github-request-idHTTP headersession.compaction_complete→requestIdx-github-request-idHTTP headerpermission.requested,external_tool.requested→requestIdUpdated:
docs/index.mdAdded API Request Reference to nav table and documentation map.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.