List agent entities.

Retrieve a list of agent entities sorted by creation time. Deprecated: some features such as agent sharing are not supported by this endpoint. Use the cursor-paginated GET /v1/agents/pages instead.

pageinteger

Page number (0-indexed)

page_sizeinteger

Number of agents per page

deployment_chatboolean nullable

sourcesRequestSource[] nullable

namestring nullable

Filter by agent name

searchstring nullable

Search agents by name or ID

idstring nullable

Response

Successful Response

instructionsstring nullable

Instruction prompt the model will follow during the conversation.

modelstring required

namestring required

descriptionstring nullable

handoffsstring[] nullable

metadataMetadataDict

Custom type for metadata with embedded validation.

object'agent'

idstring required

versioninteger required

versionsinteger[] required

created_atstring date-time required

updated_atstring date-time required

deployment_chatboolean required

sourcestring required

version_messagestring nullable

Example response

[
  {
    "completion_args": {
      "response_format": {
        "type": "text"
      }
    }
  }
]

v2

List agent entities.

Query parameters

Response

Example response