Agent API Schema

Detailed Usage of Hive Agent Server Endpoints

After starting the Hive Agent server with agent.run(), the following endpoints become available:

Read Root

GET/

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Create Table Handler

POST/api/v1/database/create-table

Body

application/json

table_name*Table Name

columns*Columns

Response

200422

Successful Response

Body

application/json

Other propertiesstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/database/create-table', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "table_name": "text"
    }),
});
const data = await response.json();

Response

422

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

Insert Data Handler

POST/api/v1/database/insert-data

Body

application/json

table_name*Table Name

data*Data

Response

200422

Successful Response

Body

application/json

Response Insert Data Handler Api V1 Database Insert Data Post

Request

JavaScriptCurlPython

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

Response

422

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

Read Data Handler

POST/api/v1/database/read-data

Body

application/json

table_name*Table Name

filtersFilters

objectnull

Response

200422

Successful Response

Body

application/json

Response Read Data Handler Api V1 Database Read Data Post

Request

JavaScriptCurlPython

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

Response

200422

[]

Update Data Handler

PUT/api/v1/database/update-data

Body

application/json

table_name*Table Name

id*Id

data*Data

Response

200422

Successful Response

Body

application/json

Other propertiesstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/database/update-data', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "table_name": "text"
    }),
});
const data = await response.json();

Response

422

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

Delete Data Handler

DELETE/api/v1/database/delete-data

Body

application/json

table_name*Table Name

id*Id

Response

200422

Successful Response

Body

application/json

Other propertiesstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/database/delete-data', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "table_name": "text"
    }),
});
const data = await response.json();

Response

422

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

Chat

POST/api/v1/chat

Body

application/json

user_id*User Id

session_id*Session Id

chat_data*ChatData

media_referencesMedia References

array of MediaReferencenull

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/chat', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_id": "text",
      "session_id": "text",
      "chat_data": {
        "messages": [
          {
            "role": "system",
            "content": "text"
          }
        ]
      }
    }),
});
const data = await response.json();

Response

422

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

Chat Media

POST/api/v1/chat_media

Body

multipart/form-data

user_id*User Id

session_id*Session Id

chat_data*Chat Data

files*Files

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/chat_media', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "user_id": "text",
      "session_id": "text",
      "chat_data": "text",
      "files": [
        "binary"
      ]
    }),
});
const data = await response.json();

Response

422

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

Get Chat History

GET/api/v1/chat_history

Query parameters

Response

200422

Successful Response

Body

application/json

user_id*User Id

session_id*Session Id

message*Message

role*Role

timestamp*Timestamp

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/chat_history?user_id=text&session_id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

[
  {
    "user_id": "text",
    "session_id": "text",
    "message": "text",
    "role": "text",
    "timestamp": "text"
  }
]

Get All Chats

GET/api/v1/all_chats

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/all_chats?user_id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

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

Create Upload Files

POST/api/v1/uploadfiles/

Body

multipart/form-data

files*Files

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/uploadfiles/', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "files": [
        "binary"
      ]
    }),
});
const data = await response.json();

Response

422

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

List Files

GET/api/v1/files/

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Delete File

DELETE/api/v1/files/{filename}

Path parameters

filename*Filename

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

422

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

Rename File

PUT/api/v1/files/{old_filename}/{new_filename}

Path parameters

old_filename*Old Filename

new_filename*New Filename

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/files/{old_filename}/{new_filename}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

422

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

Create Index

POST/api/v1/create_index/

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

422

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

Insert Documents

POST/api/v1/insert_documents/

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

422

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

Update Documents

PUT/api/v1/update_documents/

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/update_documents/?index_name=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

422

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

Delete Documents

DELETE/api/v1/delete_documents/

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/delete_documents/?index_name=text', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

422

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