\n
TypeScript
\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n model: \"gpt-5.4\",\n customAgents: [\n {\n name: \"researcher\",\n displayName: \"Research Agent\",\n description: \"Explores codebases and answers questions using read-only tools\",\n tools: [\"grep\", \"glob\", \"view\"],\n prompt: \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n {\n name: \"editor\",\n displayName: \"Editor Agent\",\n description: \"Makes targeted code changes\",\n tools: [\"view\", \"edit\", \"bash\"],\n prompt: \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n ],\n onPermissionRequest: async () => ({ kind: \"approve-once\" }),\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot import CopilotClient, PermissionDecisionApproveOnce\n\nclient = CopilotClient()\nawait client.start()\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: PermissionDecisionApproveOnce(),\n model=\"gpt-5.4\",\n custom_agents=[\n {\n \"name\": \"researcher\",\n \"display_name\": \"Research Agent\",\n \"description\": \"Explores codebases and answers questions using read-only tools\",\n \"tools\": [\"grep\", \"glob\", \"view\"],\n \"prompt\": \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n {\n \"name\": \"editor\",\n \"display_name\": \"Editor Agent\",\n \"description\": \"Makes targeted code changes\",\n \"tools\": [\"view\", \"edit\", \"bash\"],\n \"prompt\": \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n ],\n)\n```\n\n
\n\n
Go
\n\n```golang\nctx := context.Background()\nclient := copilot.NewClient(nil)\nclient.Start(ctx)\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-5.4\",\n CustomAgents: []copilot.CustomAgentConfig{\n {\n Name: \"researcher\",\n DisplayName: \"Research Agent\",\n Description: \"Explores codebases and answers questions using read-only tools\",\n Tools: []string{\"grep\", \"glob\", \"view\"},\n Prompt: \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n {\n Name: \"editor\",\n DisplayName: \"Editor Agent\",\n Description: \"Makes targeted code changes\",\n Tools: []string{\"view\", \"edit\", \"bash\"},\n Prompt: \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n },\n OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) {\n return &rpc.PermissionDecisionApproveOnce{}, nil\n },\n})\n```\n\n
\n\n
.NET
\n\n```csharp\nusing GitHub.Copilot;\nusing GitHub.Copilot.Rpc;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5.4\",\n CustomAgents = new List
\n {\n new()\n {\n Name = \"researcher\",\n DisplayName = \"Research Agent\",\n Description = \"Explores codebases and answers questions using read-only tools\",\n Tools = new List { \"grep\", \"glob\", \"view\" },\n Prompt = \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n new()\n {\n Name = \"editor\",\n DisplayName = \"Editor Agent\",\n Description = \"Makes targeted code changes\",\n Tools = new List { \"view\", \"edit\", \"bash\" },\n Prompt = \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(PermissionDecision.ApproveOnce()),\n});\n```\n\n\n\n
Java
\n\n```java\nimport com.github.copilot.CopilotClient;\nimport com.github.copilot.rpc.*;\nimport java.util.List;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-5.4\")\n .setCustomAgents(List.of(\n new CustomAgentConfig()\n .setName(\"researcher\")\n .setDisplayName(\"Research Agent\")\n .setDescription(\"Explores codebases and answers questions using read-only tools\")\n .setTools(List.of(\"grep\", \"glob\", \"view\"))\n .setPrompt(\"You are a research assistant. Analyze code and answer questions. Do not modify any files.\"),\n new CustomAgentConfig()\n .setName(\"editor\")\n .setDisplayName(\"Editor Agent\")\n .setDescription(\"Makes targeted code changes\")\n .setTools(List.of(\"view\", \"edit\", \"bash\"))\n .setPrompt(\"You are a code editor. Make minimal, surgical changes to files as requested.\")\n ))\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n}\n```\n\n
\n\n
\n
TypeScript
\n\n\n\n```typescript\nconst session = await client.createSession({\n customAgents: [\n {\n name: \"researcher\",\n prompt: \"You are a research assistant. Analyze code and answer questions.\",\n },\n {\n name: \"editor\",\n prompt: \"You are a code editor. Make minimal, surgical changes.\",\n },\n ],\n agent: \"researcher\", // Pre-select the researcher agent\n});\n```\n\n
\n\n
Python
\n\n\n\n```python\nsession = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"researcher\",\n \"prompt\": \"You are a research assistant. Analyze code and answer questions.\",\n },\n {\n \"name\": \"editor\",\n \"prompt\": \"You are a code editor. Make minimal, surgical changes.\",\n },\n ],\n agent=\"researcher\", # Pre-select the researcher agent\n)\n```\n\n
\n\n
Go
\n\n\n\n```golang\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n CustomAgents: []copilot.CustomAgentConfig{\n {\n Name: \"researcher\",\n Prompt: \"You are a research assistant. Analyze code and answer questions.\",\n },\n {\n Name: \"editor\",\n Prompt: \"You are a code editor. Make minimal, surgical changes.\",\n },\n },\n Agent: \"researcher\", // Pre-select the researcher agent\n})\n```\n\n
\n\n
.NET
\n\n\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n CustomAgents = new List
\n {\n new() { Name = \"researcher\", Prompt = \"You are a research assistant. Analyze code and answer questions.\" },\n new() { Name = \"editor\", Prompt = \"You are a code editor. Make minimal, surgical changes.\" },\n },\n Agent = \"researcher\", // Pre-select the researcher agent\n});\n```\n\n\n\n
Java
\n\n\n\n```java\nimport com.github.copilot.rpc.*;\nimport java.util.List;\n\nvar session = client.createSession(\n new SessionConfig()\n .setCustomAgents(List.of(\n new CustomAgentConfig()\n .setName(\"researcher\")\n .setPrompt(\"You are a research assistant. Analyze code and answer questions.\"),\n new CustomAgentConfig()\n .setName(\"editor\")\n .setPrompt(\"You are a code editor. Make minimal, surgical changes.\")\n ))\n .setAgent(\"researcher\") // Pre-select the researcher agent\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n```\n\n
\n\n
\n
TypeScript
\n\n```typescript\nsession.on((event) => {\n switch (event.type) {\n case \"subagent.started\":\n console.log(`▶ Sub-agent started: ${event.data.agentDisplayName}`);\n console.log(` Description: ${event.data.agentDescription}`);\n console.log(` Tool call ID: ${event.data.toolCallId}`);\n break;\n\n case \"subagent.completed\":\n console.log(`✅ Sub-agent completed: ${event.data.agentDisplayName}`);\n if (event.data.durationMs !== undefined) console.log(` Duration: ${event.data.durationMs}ms`);\n if (event.data.totalTokens !== undefined) console.log(` Tokens: ${event.data.totalTokens}`);\n if (event.data.totalToolCalls !== undefined) console.log(` Tool calls: ${event.data.totalToolCalls}`);\n break;\n\n case \"subagent.failed\":\n console.log(`❌ Sub-agent failed: ${event.data.agentDisplayName}`);\n console.log(` Error: ${event.data.error}`);\n if (event.data.durationMs !== undefined) console.log(` Duration: ${event.data.durationMs}ms`);\n break;\n\n case \"subagent.selected\":\n console.log(`🎯 Agent selected: ${event.data.agentDisplayName}`);\n console.log(` Tools: ${event.data.tools?.join(\", \") ?? \"all\"}`);\n break;\n\n case \"subagent.deselected\":\n console.log(\"↩ Agent deselected, returning to parent\");\n break;\n }\n});\n\nconst response = await session.sendAndWait({\n prompt: \"Research how authentication works in this codebase\",\n});\n```\n\n
\n\n
Python
\n\n```python\ndef handle_event(event):\n if event.type == \"subagent.started\":\n print(f\"▶ Sub-agent started: {event.data.agent_display_name}\")\n print(f\" Description: {event.data.agent_description}\")\n elif event.type == \"subagent.completed\":\n print(f\"✅ Sub-agent completed: {event.data.agent_display_name}\")\n elif event.type == \"subagent.failed\":\n print(f\"❌ Sub-agent failed: {event.data.agent_display_name}\")\n print(f\" Error: {event.data.error}\")\n elif event.type == \"subagent.selected\":\n tools = event.data.tools or \"all\"\n print(f\"🎯 Agent selected: {event.data.agent_display_name} (tools: {tools})\")\n\nunsubscribe = session.on(handle_event)\n\nresponse = await session.send_and_wait(\"Research how authentication works in this codebase\")\n```\n\n
\n\n
Go
\n\n```golang\nsession.On(func(event copilot.SessionEvent) {\n switch d := event.Data.(type) {\n case *copilot.SubagentStartedData:\n fmt.Printf(\"▶ Sub-agent started: %s\\n\", d.AgentDisplayName)\n fmt.Printf(\" Description: %s\\n\", d.AgentDescription)\n fmt.Printf(\" Tool call ID: %s\\n\", d.ToolCallID)\n case *copilot.SubagentCompletedData:\n fmt.Printf(\"✅ Sub-agent completed: %s\\n\", d.AgentDisplayName)\n case *copilot.SubagentFailedData:\n fmt.Printf(\"❌ Sub-agent failed: %s — %v\\n\", d.AgentDisplayName, d.Error)\n case *copilot.SubagentSelectedData:\n fmt.Printf(\"🎯 Agent selected: %s\\n\", d.AgentDisplayName)\n }\n})\n\n_, err := session.SendAndWait(ctx, copilot.MessageOptions{\n Prompt: \"Research how authentication works in this codebase\",\n})\n```\n\n
\n\n
.NET
\n\n```csharp\nusing var subscription = session.On
(evt =>\n{\n switch (evt)\n {\n case SubagentStartedEvent started:\n Console.WriteLine($\"▶ Sub-agent started: {started.Data.AgentDisplayName}\");\n Console.WriteLine($\" Description: {started.Data.AgentDescription}\");\n Console.WriteLine($\" Tool call ID: {started.Data.ToolCallId}\");\n break;\n case SubagentCompletedEvent completed:\n Console.WriteLine($\"✅ Sub-agent completed: {completed.Data.AgentDisplayName}\");\n break;\n case SubagentFailedEvent failed:\n Console.WriteLine($\"❌ Sub-agent failed: {failed.Data.AgentDisplayName} — {failed.Data.Error}\");\n break;\n case SubagentSelectedEvent selected:\n Console.WriteLine($\"🎯 Agent selected: {selected.Data.AgentDisplayName}\");\n break;\n }\n});\n\nawait session.SendAndWaitAsync(new MessageOptions\n{\n Prompt = \"Research how authentication works in this codebase\"\n});\n```\n\n\n\n
Java
\n\n\n\n```java\nsession.on(event -> {\n if (event instanceof SubagentStartedEvent e) {\n System.out.println(\"▶ Sub-agent started: \" + e.getData().agentDisplayName());\n System.out.println(\" Description: \" + e.getData().agentDescription());\n System.out.println(\" Tool call ID: \" + e.getData().toolCallId());\n } else if (event instanceof SubagentCompletedEvent e) {\n System.out.println(\"✅ Sub-agent completed: \" + e.getData().agentName());\n } else if (event instanceof SubagentFailedEvent e) {\n System.out.println(\"❌ Sub-agent failed: \" + e.getData().agentName());\n System.out.println(\" Error: \" + e.getData().error());\n } else if (event instanceof SubagentSelectedEvent e) {\n System.out.println(\"🎯 Agent selected: \" + e.getData().agentDisplayName());\n } else if (event instanceof SubagentDeselectedEvent e) {\n System.out.println(\"↩ Agent deselected, returning to parent\");\n }\n});\n\nvar response = session.sendAndWait(\n new MessageOptions().setPrompt(\"Research how authentication works in this codebase\")\n).get();\n```\n\n
\n\n