Default

AI Copilot

Changed on

Chat with our AI copilot powered by Neyman AI trained on the extensive Finnhub's global data. You can ask it any finance-related questions just like with other LLM models and receive results in texts and widgets.

post/ai-chat

Request

  • Base URL
    https://finnhub.io/api/v1
  • URL
    https://finnhub.io/api/v1/ai-chat
  • Auth
    API key in query parameter token

Request body

streamboolean

Stream responses

Example request

{
  "stream": true,
  "messages": [
    {
      "role": "role",
      "content": "content"
    },
    {
      "role": "role",
      "content": "content"
    }
  ]
}

Response

successful operation

chatIdstring

Chat ID.

contentstring

Response text.

querySummarystring

Query summary

relatedQueriesobject[]

Related queries.

tickersobject[]

List of tickers mentioned.

sourcesobject[]

Sources.

widgetsobject[]

Widgets.

Example response

{
  "chatId": "chatId",
  "relatedQueries": [
    "{}",
    "{}"
  ],
  "sources": [
    "{}",
    "{}"
  ],
  "widgets": [
    "{}",
    "{}"
  ],
  "tickers": [
    "{}",
    "{}"
  ],
  "content": "content",
  "querySummary": "querySummary"
}

Changes