🔃GenAI Server API's Reference

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

Session

Sessions List

GET/api/session

Response

200

Successful Response

Body

application/json

Response Sessions List Api Session Get

array of StackSessionResponseModelarray of any

Request

JavaScriptCurlPython

const response = await fetch('/api/session', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "created_at": "2024-11-21T09:15:37.922Z",
    "modified_at": "2024-11-21T09:15:37.922Z"
  }
]

Create Session

POST/api/session

Response

200

Successful Response

Body

application/json

created_at*Created At

modified_atModified At

id*Id

stack_id*Stack Id

meta_data*Meta Data

Request

JavaScriptCurlPython

const response = await fetch('/api/session', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "created_at": "2024-11-21T09:15:37.922Z",
  "modified_at": "2024-11-21T09:15:37.922Z"
}

Get Session

GET/api/session/{session_id}

Path parameters

session_id*Session Id

Response

200422

Successful Response

Body

application/json

created_at*Created At

modified_atModified At

id*Id

stack_id*Stack Id

meta_data*Meta Data

Request

JavaScriptCurlPython

const response = await fetch('/api/session/{session_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "created_at": "2024-11-21T09:15:37.922Z",
  "modified_at": "2024-11-21T09:15:37.922Z"
}

Delete Session

DELETE/api/session/{session_id}

Path parameters

session_id*Session Id

Response

200422

Successful Response

Body

application/json

Response Delete Session Api Session Session Id Delete

Request

JavaScriptCurlPython

const response = await fetch('/api/session/{session_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

ETL

Extract

POST/api/etl/submit-job

Query parameters

Response

200422

Successful Response

Body

application/json

id*Id

session_id*Session Id

status*ETLJobStatus

An enumeration.

pendingprocessingcompleted

metadataMetadata

Request

JavaScriptCurlPython

const response = await fetch('/api/etl/submit-job', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "status": "pending"
}

Model

Predict

POST/api/model/predict

Body

application/json

prompt*Prompt

Response

200422

Successful Response

Body

application/json

output*Output

Request

JavaScriptCurlPython

const response = await fetch('/api/model/predict', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prompt": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "output": "text"
}

Retriever

Retrieve

GET/api/retriever/retrieve

Query parameters

Response

200422

Successful Response

Body

application/json

session_id*Session Id

output*Output

Request

JavaScriptCurlPython

const response = await fetch('/api/retriever/retrieve?query=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "output": "text"
}

Vectordb

Add Documents

POST/api/vectordb/add-documents

Body

application/json

session_id*Session Id

documents*Documents

Response

200422

Successful Response

Body

application/json

session_id*Session Id

documents*Documents

Request

JavaScriptCurlPython

const response = await fetch('/api/vectordb/add-documents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "documents": [
        {
          "page_content": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200422

{
  "documents": [
    {
      "page_content": "text"
    }
  ]
}

Search

GET/api/vectordb/search

Body

application/json

session_id*Session Id

query*Query

Response

200422

Successful Response

Body

application/json

session_id*Session Id

documents*Documents

Request

JavaScriptCurlPython

const response = await fetch('/api/vectordb/search', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "documents": [
    {
      "page_content": "text"
    }
  ]
}