Sign in
copilot

Send a message to the AI copilot (domain-specific)

Changed on
post/copilot/chat

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/copilot/chat
  • Auth: one of:
    • API key in cookie session
    • HTTP bearer

Request body

agentIdstring

Domain agent identifier (e.g. vessels, terra, command)

contextobject

Additional context passed to the system prompt

streamboolean

If true, response is streamed as SSE; if false, returned as JSON

Response

AI response (JSON) or SSE stream when stream=true

contentstring

Changes