Skip to main content
GET
/
v1
/
agents
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const agentView of client.agents.list()) {
  console.log(agentView.id);
}
{
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "version": "<string>",
      "create_time_ms": 123,
      "is_public": true,
      "source": {
        "type": "<string>",
        "npm": {
          "package_name": "<string>",
          "registry_url": "<string>",
          "agent_setup": [
            "<string>"
          ]
        },
        "pip": {
          "package_name": "<string>",
          "registry_url": "<string>",
          "agent_setup": [
            "<string>"
          ]
        },
        "object": {
          "object_id": "<string>",
          "agent_setup": [
            "<string>"
          ]
        },
        "git": {
          "repository": "<string>",
          "ref": "<string>",
          "agent_setup": [
            "<string>"
          ]
        }
      }
    }
  ],
  "has_more": true,
  "total_count": 123,
  "remaining_count": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer<int32>

The limit of items to return. Default is 20. Max is 5000.

starting_after
string

Load the next page of data starting after the item with the given ID.

name
string

Filter agents by name (partial match supported).

is_public
boolean

Filter agents by public visibility.

Search by agent ID or name.

version
string

Filter by version. Use 'latest' to get the most recently created agent.

Response

Successfully retrieved list of Agents.

A paginated list of Agents.

agents
object[]
required

The list of Agents.

has_more
boolean
required

Whether there are more Agents to fetch.

total_count
integer<int32>
required

The total count of Agents.

remaining_count
integer<int32>
required

The count of remaining Agents.