Skip to main content
POST
/
api
/
in
/
v0
/
documents
/
embeddings-search
Filings Embeddings Search
curl --request POST \
  --url https://stockinsights-ai-main-95a26a0.zuplo.app/api/in/v0/documents/embeddings-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "filters": {
    "types": [
      "earnings-transcript"
    ],
    "tickers": [
      "NSE:OLECTRA"
    ],
    "sectors": [
      "<string>"
    ],
    "industries": [
      "<string>"
    ],
    "years": [
      "<string>"
    ],
    "quarters": [
      "Q1"
    ]
  },
  "top_k": 10
}
'
{
  "status": "<string>",
  "data": [
    {
      "text": "<string>",
      "metadata": {
        "chunk_num": "<string>"
      },
      "document": {
        "type": "<string>",
        "published_date": "2023-11-07T05:31:56Z",
        "year": "<string>",
        "quarter": "Q1",
        "link": "<string>"
      },
      "company": {
        "id": "<string>",
        "company_name": "<string>",
        "ticker": "<string>",
        "exchange_tickers": [
          {
            "exchange": "BSE",
            "ticker": "<string>",
            "id": "<string>",
            "url": "<string>"
          }
        ]
      },
      "similarity_score": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.stockinsights.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string
required

The user query in natural language for which similar chunks of filings text is retrieved using OpenAI embeddings.

filters
object
required

Filters to narrow the search scope. filters.types is required and must contain at least one filing type.

top_k
integer
default:10

Number of top matching chunks to return in the response. This parameter is optional and defaults to 20 if not specified. Maximum value is 50.

Required range: x <= 100

Response

Successful response. Contains the list of chunks for given query vector

status
string

Status code

data
object[]