Main WebsitePricingGitHubDiscordX

Agent API Schema

Detailed Usage of Agent Server Endpoints

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

Read Root

get
Responses
200
Successful Response
application/json
Responseany
get
GET / HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

Create Table Handler

post
Body
table_namestringRequired
Responses
200
Successful Response
application/json
post
POST /api/v1/database/create-table HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "table_name": "text",
  "columns": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Insert Data Handler

post
Body
table_namestringRequired
dataobject · DataRequired
Responses
200
Successful Response
application/json
Responseobject · ResponseInsertDataHandlerApiV1DatabaseInsertDataPost
post
POST /api/v1/database/insert-data HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "table_name": "text",
  "data": {}
}
{}

Read Data Handler

post
Body
table_namestringRequired
filtersany ofOptional
or
nullOptional
Responses
200
Successful Response
application/json
Responseobject[]
post
POST /api/v1/database/read-data HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "table_name": "text",
  "filters": {
    "ANY_ADDITIONAL_PROPERTY": []
  }
}
[
  {}
]

Update Data Handler

put
Body
table_namestringRequired
idintegerRequired
dataobject · DataRequired
Responses
200
Successful Response
application/json
put
PUT /api/v1/database/update-data HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "table_name": "text",
  "id": 1,
  "data": {}
}
{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Delete Data Handler

delete
Body
table_namestringRequired
idintegerRequired
Responses
200
Successful Response
application/json
delete
DELETE /api/v1/database/delete-data HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "table_name": "text",
  "id": 1
}
{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Chat

post
Body
user_idstringRequired
session_idstringRequired
chat_datastringRequired
filesstring · binary[]OptionalDefault: []
Responses
200
Successful Response
application/json
Responseany
post
POST /api/v1/chat HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 76

{
  "user_id": "text",
  "session_id": "text",
  "chat_data": "text",
  "files": [
    "binary"
  ]
}
No content

Get Chat History

get
Query parameters
user_idstringRequired
session_idstringRequired
Responses
200
Successful Response
application/json
get
GET /api/v1/chat_history?user_id=text&session_id=text HTTP/1.1
Host: 
Accept: */*

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

Get All Chats

get
Query parameters
user_idstringRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/v1/all_chats?user_id=text HTTP/1.1
Host: 
Accept: */*

No content

Create Upload Files

post
Body
filesstring · binary[]Required
Responses
200
Successful Response
application/json
Responseany
post
POST /api/v1/uploadfiles/ HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "files": [
    "binary"
  ]
}
No content

List Files

get
Responses
200
Successful Response
application/json
Responseany
get
GET /api/v1/files/ HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

Delete File

delete
Path parameters
filenamestringRequired
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/v1/files/{filename} HTTP/1.1
Host: 
Accept: */*

No content

Rename File

put
Path parameters
old_filenamestringRequired
new_filenamestringRequired
Responses
200
Successful Response
application/json
Responseany
put
PUT /api/v1/files/{old_filename}/{new_filename} HTTP/1.1
Host: 
Accept: */*

No content

Create Index

post
Query parameters
index_namestringRequired
folder_pathstringOptional
index_typeanyOptional
Body
string[]Optional
Responses
200
Successful Response
application/json
Responseany
post
POST /api/v1/create_index/?index_name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content

Insert Documents

post
Query parameters
index_namestringRequired
folder_pathstringOptional
Body
string[]Optional
Responses
200
Successful Response
application/json
Responseany
post
POST /api/v1/insert_documents/?index_name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content

Update Documents

put
Query parameters
index_namestringRequired
folder_pathstringOptional
Body
string[]Optional
Responses
200
Successful Response
application/json
Responseany
put
PUT /api/v1/update_documents/?index_name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content

Delete Documents

delete
Query parameters
index_namestringRequired
folder_pathstringOptional
Body
string[]Optional
Responses
200
Successful Response
application/json
Responseany
delete
DELETE /api/v1/delete_documents/?index_name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content

Health

get
Responses
200
Successful Response
application/json
Responseany
get
GET /health HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

Install Tool

post
Body
github_urlstringRequired
functionsstring[]Required
install_pathany ofRequired
stringOptional
or
nullOptional
github_tokenany ofOptional
stringOptional
or
nullOptional
env_varsany ofOptional
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
post
POST /api/v1/install_tools HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 134

[
  {
    "github_url": "text",
    "functions": [
      "text"
    ],
    "install_path": "text",
    "github_token": "text",
    "env_vars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]
No content

Sample Prompts

get
Responses
200
Successful Response
application/json
Responseany
get
GET /api/v1/sample_prompts HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

PreviousAgent KitNextObservability

Last updated

Was this helpful?