Agent API Schema

Detailed Usage of Agent Server Endpoints

PreviousAgent Kit NextObservability

Last updated 5 months ago

Was this helpful?

Create Table Handler

post

Body

table_namestringrequired

columnsobjectrequired

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": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }'

200

422

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Successful Response

Insert Data Handler

post

Body

table_namestringrequired

dataobjectrequired

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

Body

table_namestringrequired

filtersany of

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

Body

table_namestringrequired

idintegerrequired

dataobjectrequired

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

Body

table_namestringrequired

idintegerrequired

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

Body

user_idstringrequired

session_idstringrequired

chat_datastringrequired

filesstring · binary[] · default:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/chat' \
  --header 'Content-Type: multipart/form-data' \
  --form 'user_id=text' \
  --form 'session_id=text' \
  --form 'chat_data=text' \
  --form 'files='

200

422

No body

Successful Response

Get Chat History

get

Query parameters

user_idstringrequired

session_idstringrequired

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

Query parameters

user_idstringrequired

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

Body

filesstring · binary[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/uploadfiles/' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=text'

200

422

No body

Successful Response

Delete File

delete

Path parameters

filenamestringrequired

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

Path parameters

old_filenamestringrequired

new_filenamestringrequired

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

Query parameters

index_namestringrequired

folder_pathstring

index_typeany

Body

string[]

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 '[
    "text"
  ]'

200

422

No body

Successful Response

Insert Documents

post

Query parameters

index_namestringrequired

folder_pathstring

Body

string[]

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 '[
    "text"
  ]'

200

422

No body

Successful Response

Update Documents

put

Query parameters

index_namestringrequired

folder_pathstring

Body

string[]

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 '[
    "text"
  ]'

200

422

No body

Successful Response

Delete Documents

delete

Query parameters

index_namestringrequired

folder_pathstring

Body

string[]

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 '[
    "text"
  ]'

200

422

No body

Successful Response

Install Tool

post

Body

github_urlstringrequired

functionsstring[]required

install_pathany ofrequired

github_tokenany of

env_varsany of

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": [
        "text"
      ],
      "install_path": "text",
      "github_token": "text",
      "env_vars": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]'

200

422

No body

Successful Response

Agent API Schema

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

Read Root

Create Table Handler

Show Columns

Insert Data Handler

Read Data Handler

Show child attributes

Show child attributes

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

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Sample Prompts