Orbit Platform Documentation
DocsAPI ReferenceHomepageSign In
API Reference
API Reference
  • Reference
    • Introduction
    • Authentication
  • ENDPOINTS
    • Equity Lookup
    • Retrive Report List
    • Chat with a report
    • Metainfo - Report Type Classification
Powered by GitBook
On this page
  1. ENDPOINTS

Chat with a report

Chat with a report

GET /v1/chat/chat_report

POST {{baseUrl}}/{{version}}/chat/chat_report
Content-Type: application/json
X-API-KEY: <token>

{
  "report_id": "f_0UwYjo28DaDWedx2JZ42rz",
  "question": "hello"
}

Ask a AI question regarding a report.

Headers

Name
Value

Content-Type

application/json

X-API-KEY

<token>

Body

Name
Type
Description

report_id

string

Report ID

question

string

Question would like to ask

Response

{
  "status_code": 200,
  "data": {
    "request_params": {
      "report_id": "f_0UwYjo28DaDWedx2JZ42rz",
      "question": "hello"
    },
    "answer": "Hello! How can I assist you today?",
    "reference": [
      {
        "attachment": "ohHiFb3O",
        "page": 2
      },
      {
        "attachment": "kqKqBlO6",
        "page": 3
      },
      {
        "attachment": "ohHiFb3O",
        "page": 3
      },
      {
        "attachment": "ohHiFb3O",
        "page": 4
      }
    ],
    "error": false
  },
  "detail": null,
  "message": "success"
}
{
  "error": "Invalid request"
}

PreviousRetrive Report ListNextMetainfo - Report Type Classification

Last updated 3 months ago