List
List Agents
get/v2/gen-ai/agents
To list all agents, send a GET request to /v2/gen-ai/agents.
Query Parameters
only_deployedboolean
optional
only list agents that are deployed.
pagenumber
optional
page number.
formatint64
per_pagenumber
optional
items per page.
formatint64
Returns
Request example cURL
curl https://api.digitalocean.com//v2/gen-ai/agents \
-H "Authorization: Bearer $GRADIENTAI_API_KEY"200 Example
{
"agents": [
{
"chatbot": {
"button_background_color": "button_background_color",
"logo": "logo",
"name": "name",
"primary_color": "primary_color",
"secondary_color": "secondary_color",
"starting_message": "starting_message"
},
"chatbot_identifiers": [
{
"agent_chatbot_identifier": "agent_chatbot_identifier"
}
],
"created_at": "2019-12-27T18:11:19.117Z",
"deployment": {
"created_at": "2019-12-27T18:11:19.117Z",
"name": "name",
"status": "STATUS_UNKNOWN",
"updated_at": "2019-12-27T18:11:19.117Z",
"url": "url",
"uuid": "uuid",
"visibility": "VISIBILITY_UNKNOWN"
},
"description": "description",
"if_case": "if_case",
"instruction": "instruction",
"k": 0,
"max_tokens": 0,
"model": {
"agreement": {
"description": "description",
"name": "name",
"url": "url",
"uuid": "uuid"
},
"created_at": "2019-12-27T18:11:19.117Z",
"inference_name": "inference_name",
"inference_version": "inference_version",
"is_foundational": true,
"metadata": {},
"name": "name",
"parent_uuid": "parent_uuid",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2019-12-27T18:11:19.117Z",
"upload_complete": true,
"url": "url",
"usecases": [
"MODEL_USECASE_UNKNOWN"
],
"uuid": "uuid",
"version": {
"major": 0,
"minor": 0,
"patch": 0
}
},
"name": "name",
"project_id": "project_id",
"provide_citations": true,
"region": "region",
"retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
"route_created_at": "2019-12-27T18:11:19.117Z",
"route_created_by": "route_created_by",
"route_name": "route_name",
"route_uuid": "route_uuid",
"tags": [
"string"
],
"temperature": 0,
"template": {
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"guardrails": [
{
"priority": 0,
"uuid": "uuid"
}
],
"instruction": "instruction",
"k": 0,
"knowledge_bases": [
{
"added_to_agent_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"database_id": "database_id",
"embedding_model_uuid": "embedding_model_uuid",
"is_public": true,
"last_indexing_job": {
"completed_datasources": 0,
"created_at": "2019-12-27T18:11:19.117Z",
"data_source_uuids": [
"string"
],
"finished_at": "2019-12-27T18:11:19.117Z",
"knowledge_base_uuid": "knowledge_base_uuid",
"phase": "BATCH_JOB_PHASE_UNKNOWN",
"started_at": "2019-12-27T18:11:19.117Z",
"status": "INDEX_JOB_STATUS_UNKNOWN",
"tokens": 0,
"total_datasources": 0,
"updated_at": "2019-12-27T18:11:19.117Z",
"uuid": "uuid"
},
"name": "name",
"project_id": "project_id",
"region": "region",
"tags": [
"string"
],
"updated_at": "2019-12-27T18:11:19.117Z",
"user_id": "user_id",
"uuid": "uuid"
}
],
"long_description": "long_description",
"max_tokens": 0,
"model": {
"agreement": {
"description": "description",
"name": "name",
"url": "url",
"uuid": "uuid"
},
"created_at": "2019-12-27T18:11:19.117Z",
"inference_name": "inference_name",
"inference_version": "inference_version",
"is_foundational": true,
"metadata": {},
"name": "name",
"parent_uuid": "parent_uuid",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2019-12-27T18:11:19.117Z",
"upload_complete": true,
"url": "url",
"usecases": [
"MODEL_USECASE_UNKNOWN"
],
"uuid": "uuid",
"version": {
"major": 0,
"minor": 0,
"patch": 0
}
},
"name": "name",
"short_description": "short_description",
"summary": "summary",
"tags": [
"string"
],
"temperature": 0,
"template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
"top_p": 0,
"updated_at": "2019-12-27T18:11:19.117Z",
"uuid": "uuid"
},
"top_p": 0,
"updated_at": "2019-12-27T18:11:19.117Z",
"url": "url",
"user_id": "user_id",
"uuid": "uuid"
}
],
"links": {
"pages": {
"first": "first",
"last": "last",
"next": "next",
"previous": "previous"
}
},
"meta": {
"page": 0,
"pages": 0,
"total": 0
}
}