1. Docs
2. Reference
3. REST API Docs
4. Schema
5. CopilotResponse

Response from Copilot skill invocation

Properties

• messages array[CopilotMessage] optional
  Messages in the conversation (typically from the assistant)
• ↳ role enum optional
  Message author: ‘assistant’ (AI) or ‘user’
  Values: user, assistant
• ↳ kind enum optional
  Message type: ‘response’ (text), ‘program’ (generated code), ‘improvedProgram’ (improved code)
  Values: response, program, improvedProgram
• ↳ content object optional
  The actual message content (text string for ‘response’ kind, or structured object for ‘program’/‘improvedProgram’ kinds)
• error string optional
  Error message if the request failed
• details string optional
  Additional error context or debugging information