v1
latestOpenAPI 3.0.22026-07-174617345.8 KBAgents
List all agents.
Returns a list of your agents (formerly known as projects). The agents are returned sorted by creation date, with the most recent agents appearing first. It is a paginated API and you can use the page parameter to fetch the next page of agents. The default page size is 10.
Here is an example to list agents: using API and using our python SDK.
get/api/v1/projects
Query parameters
pageinteger
Example:1
Page number to return
durationinteger
The duration of the agents to list.
order'asc' | 'desc'
Example:desc
The order of the agents to list. Defaults to desc.
orderBy'id' | 'created_at'
Example:id
The orderBy to sort the results by given field
widthstring
Example:50rem
The width of the embed code. Defaults to 100%.
heightstring
Example:50rem
The height of the embed code. Defaults to 100%.
namestring
Example:Sample agent
Filter the results by agent name
Response
Successfully retrieved list of agents that belong to the user.
Example response
{
"status": "success",
"data": {
"current_page": 1,
"data": [
{
"id": 1,
"project_name": "My Agent",
"sitemap_path": "https://www.example.com/sitemap.xml",
"is_chat_active": true,
"user_id": 1,
"team_id": 1,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00",
"deleted_at": "2021-01-01 00:00:00",
"type": "SITEMAP",
"is_shared": true,
"shareable_slug": "1234567890abcdef1234567890abcdef",
"are_licenses_allowed": true
}
],
"first_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"next_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"path": "https://app.customgpt.ai/api/v1/users?page=1",
"per_page": 10,
"prev_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"to": 1,
"total": 1
}
}