Copilot

Ask NZXplorer Copilot

Natural language query interface backed by Claude Sonnet with tool-calling against 100+ internal API endpoints. Returns SSE streaming response. Supports personas, session memory, and structured card responses.

post/ask

Request

  • Base URL: https://nzxplorer.co.nz/api/v1
  • URL: https://nzxplorer.co.nz/api/v1/ask
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Request body

questionstring required

Natural language query about NZX data

messagestring

Alias for question

personastring

Persona ID (e.g. macro, governance, risk, buffett, fund_manager)

session_idstring

Session UUID for conversation continuity

Response

SSE streaming response

Changes

No recorded changes to this operation across all 1 revision of this API.