OpenAPI 3.1.0raw.githubusercontent.com2026-08-212796513.1 MB

4fdc24e562eb

Agents

List agents

List all agents in the workspace with full configuration details. Supports pagination and sorts agents newest first.

get/v2/agents

Query parameters

limitnumber

A limit on the number of objects to be returned. Limit can range between 1 and 200. When not provided, returns all agents without pagination.

A limit on the number of objects to be returned. Limit can range between 1 and 200. When not provided, returns all agents without pagination.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

type'internal'

Filter agents by type

Filter agents by type

Response

Successfully retrieved the list of agents. Returns a paginated response containing agent manifests with complete configurations, including primary and fallback models, tools, knowledge bases, and execution settings.

object'list' required
has_moreboolean required

Example response

{
  "data": [
    {
      "path": "Default Project",
      "knowledge_bases": [
        {
          "knowledge_id": "customer-knowledge-base"
        }
      ],
      "model": {
        "parameters": {
          "fallbacks": [
            {
              "model": "openai/gpt-4o-mini"
            }
          ],
          "cache": {
            "ttl": 3600
          },
          "load_balancer": {
            "type": "weight_based",
            "models": [
              {
                "model": "openai/gpt-4o",
                "weight": 0.7
              },
              {
                "model": "anthropic/claude-3-5-sonnet",
                "weight": 0.3
              }
            ]
          },
          "timeout": {
            "call_timeout": 30000
          }
        },
        "retry": {
          "count": 3,
          "on_codes": [
            429,
            500,
            502,
            503,
            504
          ]
        },
        "fallback_models": [
          {
            "parameters": {
              "fallbacks": [
                {
                  "model": "openai/gpt-4o-mini"
                }
              ],
              "cache": {
                "ttl": 3600
              },
              "load_balancer": {
                "type": "weight_based",
                "models": [
                  {
                    "model": "openai/gpt-4o",
                    "weight": 0.7
                  },
                  {
                    "model": "anthropic/claude-3-5-sonnet",
                    "weight": 0.3
                  }
                ]
              },
              "timeout": {
                "call_timeout": 30000
              }
            },
            "retry": {
              "count": 3,
              "on_codes": [
                429,
                500,
                502,
                503,
                504
              ]
            }
          }
        ]
      }
    }
  ]
}