Agent API Schema

Detailed Usage of Agent Server Endpoints

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

PreviousAgent Kit NextObservability

Last updated 4 months ago

Was this helpful?

Create Table Handler

post

/api/v1/database/create-table

Body

table_nameTable Namerequired

columnsColumnsrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/database/create-table' \
  --header 'Content-Type: application/json' \
  --data '{"table_name":"text","columns":{}}'

200

422

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Successful Response

Insert Data Handler

post

/api/v1/database/insert-data

Body

table_nameTable Namerequired

dataDatarequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/database/insert-data' \
  --header 'Content-Type: application/json' \
  --data '{"table_name":"text","data":{}}'

200

422

{}

Successful Response

Read Data Handler

post

/api/v1/database/read-data

Body

table_nameTable Namerequired

filtersFilters

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/database/read-data' \
  --header 'Content-Type: application/json' \
  --data '{"table_name":"text","filters":{"ANY_ADDITIONAL_PROPERTY":[]}}'

200

422

[
  {}
]

Successful Response

Update Data Handler

put

/api/v1/database/update-data

Body

table_nameTable Namerequired

idIdrequired

dataDatarequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/database/update-data' \
  --header 'Content-Type: application/json' \
  --data '{"table_name":"text","id":1,"data":{}}'

200

422

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Successful Response

Delete Data Handler

delete

/api/v1/database/delete-data

Body

table_nameTable Namerequired

idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/database/delete-data' \
  --header 'Content-Type: application/json' \
  --data '{"table_name":"text","id":1}'

200

422

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Successful Response

Chat

post

/api/v1/chat

Body

user_idUser Idrequired

session_idSession Idrequired

chat_dataChat Datarequired

filesFiles

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/chat' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"user_id":"text","session_id":"text","chat_data":"text","files":[]}'

200

422

No body

Successful Response

Get Chat History

get

/api/v1/chat_history

Query parameters

user_idUser Idrequired

session_idSession Idrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/chat_history?user_id=text&session_id=text'

200

422

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

Successful Response

Get All Chats

get

/api/v1/all_chats

Query parameters

user_idUser Idrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/all_chats?user_id=text'

200

422

No body

Successful Response

Create Upload Files

post

/api/v1/uploadfiles/

Body

filesFilesrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/uploadfiles/' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"files":[null]}'

200

422

No body

Successful Response

Delete File

delete

/api/v1/files/{filename}

Path parameters

filenameFilenamerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/files/{filename}'

200

422

No body

Successful Response

Rename File

put

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

Path parameters

old_filenameOld Filenamerequired

new_filenameNew Filenamerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/files/{old_filename}/{new_filename}'

200

422

No body

Successful Response

Create Index

post

/api/v1/create_index/

Query parameters

index_nameIndex Namerequired

folder_pathFolder Path

index_typeIndex Type

Body

itemsstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/create_index/?index_name=text' \
  --header 'Content-Type: application/json' \
  --data '[null]'

200

422

No body

Successful Response

Insert Documents

post

/api/v1/insert_documents/

Query parameters

index_nameIndex Namerequired

folder_pathFolder Path

Body

itemsstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/insert_documents/?index_name=text' \
  --header 'Content-Type: application/json' \
  --data '[null]'

200

422

No body

Successful Response

Update Documents

put

/api/v1/update_documents/

Query parameters

index_nameIndex Namerequired

folder_pathFolder Path

Body

itemsstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/update_documents/?index_name=text' \
  --header 'Content-Type: application/json' \
  --data '[null]'

200

422

No body

Successful Response

Delete Documents

delete

/api/v1/delete_documents/

Query parameters

index_nameIndex Namerequired

folder_pathFolder Path

Body

itemsstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/delete_documents/?index_name=text' \
  --header 'Content-Type: application/json' \
  --data '[null]'

200

422

No body

Successful Response

Install Tool

post

/api/v1/install_tools

Body

github_urlGithub Urlrequired

functionsFunctionsrequired

install_pathInstall Pathrequired

github_tokenGithub Token

env_varsEnv Vars

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/install_tools' \
  --header 'Content-Type: application/json' \
  --data '[{"github_url":"text","functions":[null],"env_vars":{}}]'

200

422

No body

Successful Response

Agent API Schema

Read Root

Create Table Handler

Insert Data Handler

Read Data Handler

Update Data Handler

Delete Data Handler

Chat

Get Chat History

Get All Chats

Create Upload Files

List Files

Delete File

Rename File

Create Index

Insert Documents

Update Documents

Delete Documents

Health

Install Tool

Sample Prompts