🔃GenAI Server API's Reference

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

Session

Sessions List

get

Responses

200

Successful Response

application/json

Responseany of

or

get

HTTPcURLJavaScriptPython

GET /api/session HTTP/1.1
Host: 
Accept: */*

200

Successful Response

[
  {
    "created_at": "2025-06-26T08:37:04.593Z",
    "modified_at": "2025-06-26T08:37:04.593Z",
    "id": 1,
    "stack_id": 1,
    "meta_data": {}
  }
]

Create Session

post

Responses

200

Successful Response

application/json

post

HTTPcURLJavaScriptPython

POST /api/session HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "created_at": "2025-06-26T08:37:04.593Z",
  "modified_at": "2025-06-26T08:37:04.593Z",
  "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

HTTPcURLJavaScriptPython

GET /api/session/{session_id} HTTP/1.1
Host: 
Accept: */*

{
  "created_at": "2025-06-26T08:37:04.593Z",
  "modified_at": "2025-06-26T08:37:04.593Z",
  "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

HTTPcURLJavaScriptPython

DELETE /api/session/{session_id} HTTP/1.1
Host: 
Accept: */*

{}

ETL

Extract

post

Query parameters

session_idintegerOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/etl/submit-job HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "session_id": 1,
  "status": "pending",
  "metadata": {}
}

Model

Predict

post

Body

promptstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/model/predict HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "prompt": "text"
}

{
  "output": "text"
}

Retriever

Retrieve

get

Query parameters

session_idintegerRequired

querystringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/retriever/retrieve?session_id=1&query=text HTTP/1.1
Host: 
Accept: */*

{
  "session_id": 1,
  "output": "text"
}

Vectordb

Add Documents

post

Body

session_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

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": {}
    }
  ]
}