insights

Create Insight

Create a new insight. Accepts InsightCreate Schema as input.

post/insight

Request

  • Base URL: https://api.overfit.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.overfit.de/insight
  • Auth: one of:
    • OpenID Connect (https://auth.okns.de/realms/overfit-products/.well-known/openid-configuration)
    • API key in header X-API-Key

Request body

namestring required
descriptionstring nullable
embedding_modelstring
generative_modelstring
temperaturenumber
text_qa_templatestring nullable
top_kinteger
publicboolean nullable
insight_paramsobject nullable

Example request

{
  "description": "RAG over EU regulation documents",
  "embedding_model": "text-embedding-3-small",
  "generative_model": "gpt-4o-mini",
  "name": "EU Regulation Insight",
  "temperature": 0.3,
  "top_k": 5
}

Response

Successful Response

idstring required
namestring required
descriptionstring nullable
embedding_modelstring required
generative_modelstring required
temperaturenumber required
text_qa_templatestring nullable
top_kinteger
vector_store_idstring required
time_createdstring date-time required
substring uuid required

Changes

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