GenAI Stack (old)
v0.2.0
v0.2.0
  • Getting Started
    • ๐Ÿ’ฌIntroduction
    • ๐Ÿš€Quickstart with colab
    • ๐Ÿ“˜Default Data Types
    • ๐Ÿช›Installation
  • Components
    • โœจIntroduction
    • ๐ŸšœETL
      • ๐Ÿ”ฅQuickstart
      • ๐ŸฆœLangchain
      • ๐Ÿฆ™LLama Hub
    • ๐ŸŒฑEmbeddings
      • ๐Ÿ”ฅQuickstart
      • ๐ŸฆœLangchain
      • ๐Ÿ“–Advanced Usage
    • ๐Ÿ”ฎVector Database
      • ๐Ÿ”ฅQuickstart
      • ๐Ÿ“ฆChromadb
      • ๐Ÿ“ฆWeaviate
      • ๐Ÿ“–Advanced Usage
    • ๐Ÿ“šPrompt Engine
      • ๐Ÿ”ฅQuickstart
      • ๐Ÿ“–Advanced Usage
    • ๐Ÿ“คRetrieval
      • ๐Ÿ”ฅQuickstart
      • ๐Ÿ“–Advanced Usage
    • ๏ธ๏ธ๏ธ๐Ÿ—ƒ๏ธ LLM Cache
      • ๐Ÿ”ฅQuickstart
    • ๐Ÿ“ฆMemory
      • ๐Ÿ”ฅQuickstart
      • ๐Ÿ“–Advanced Usage
    • ๐Ÿฆ„LLMs
      • OpenAI
      • GPT4All
      • Hugging Face
      • Custom Model
  • Advanced Guide
    • ๐Ÿ’ปGenAI Stack API Server
    • ๐Ÿ”ƒGenAI Server API's Reference
  • Example Use Cases
    • ๐Ÿ’ฌChat on PDF
    • ๐Ÿ’ฌChat on CSV
    • ๐Ÿ’ฌSimilarity Search on JSON
    • ๐Ÿ“–Document Search
    • ๐Ÿ’ฌRAG pipeline
    • ๐Ÿ“šInformation Retrieval Pipeline
  • ๐Ÿง‘CONTRIBUTING.md
Powered by GitBook
On this page
  1. Advanced Guide

GenAI Server API's Reference

PreviousGenAI Stack API ServerNextChat on PDF

Last updated 1 year ago

Here are the API's for the core components of GenAI Stack Server.

Session

ETL

Model

Retriever

Vectordb

๐Ÿ”ƒ

Sessions List

get
Responses
200
Successful Response
application/json
Responseany of
or
get
GET /api/session HTTP/1.1
Host: 
Accept: */*
200

Successful Response

[
  {
    "created_at": "2025-06-04T15:36:24.928Z",
    "modified_at": "2025-06-04T15:36:24.928Z",
    "id": 1,
    "stack_id": 1,
    "meta_data": {}
  }
]

Create Session

post
Responses
200
Successful Response
application/json
post
POST /api/session HTTP/1.1
Host: 
Accept: */*
200

Successful Response

{
  "created_at": "2025-06-04T15:36:24.928Z",
  "modified_at": "2025-06-04T15:36:24.928Z",
  "id": 1,
  "stack_id": 1,
  "meta_data": {}
}

Get Session

get
Path parameters
session_idintegerRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/session/{session_id} HTTP/1.1
Host: 
Accept: */*
{
  "created_at": "2025-06-04T15:36:24.928Z",
  "modified_at": "2025-06-04T15:36:24.928Z",
  "id": 1,
  "stack_id": 1,
  "meta_data": {}
}

Delete Session

delete
Path parameters
session_idintegerRequired
Responses
200
Successful Response
application/json
Responseobject ยท ResponseDeleteSessionApiSessionSessionIdDelete
422
Validation Error
application/json
delete
DELETE /api/session/{session_id} HTTP/1.1
Host: 
Accept: */*
{}

Extract

post
Query parameters
session_idintegerOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /api/etl/submit-job HTTP/1.1
Host: 
Accept: */*
{
  "id": 1,
  "session_id": 1,
  "status": "pending",
  "metadata": {}
}

Retrieve

get
Query parameters
session_idintegerRequired
querystringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/retriever/retrieve?session_id=1&query=text HTTP/1.1
Host: 
Accept: */*
{
  "session_id": 1,
  "output": "text"
}
  • Session
  • GETSessions List
  • POSTCreate Session
  • GETGet Session
  • DELETEDelete Session
  • ETL
  • POSTExtract
  • Model
  • POSTPredict
  • Retriever
  • GETRetrieve
  • Vectordb
  • POSTAdd Documents
  • GETSearch

Predict

post
Body
promptstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /api/model/predict HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "prompt": "text"
}
{
  "output": "text"
}

Add Documents

post
Body
session_idintegerRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /api/vectordb/add-documents HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "session_id": 1,
  "documents": [
    {
      "page_content": "text",
      "metadata": {}
    }
  ]
}
{
  "session_id": 1,
  "documents": [
    {
      "page_content": "text",
      "metadata": {}
    }
  ]
}

Search

get
Body
session_idintegerRequired
querystringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/vectordb/search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "session_id": 1,
  "query": "text"
}
{
  "session_id": 1,
  "documents": [
    {
      "page_content": "text",
      "metadata": {}
    }
  ]
}