# List all available examples

Source: <https://everruns.com/docs/api/operations/list_agent_examples/>

[Docs](https://everruns.com/docs/)/[API reference](https://everruns.com/docs/api/)/[Agents & authoring](https://everruns.com/docs/api/groups/agents-authoring/)/List all available examples

# List all available examples

Preview

List all available examples

Public APIEverruns Cloud and self-hosted Platform

GET`/v1/agent-examples`

See [authentication](https://everruns.com/docs/sre/runbooks/authentication/) for credentials and permissions.

## Responses

200List of agent examples

### 200

List of agent examples

Media typeapplication/json

Array\<object>

A read-only agent example defined in code

object

**capabilities**

required

Capability IDs this example uses

Array\<object>

Per-agent capability configuration

Associates a capability with an agent, including optional per-agent configuration. The config field allows the same capability to behave differently per-agent.

object

**config**

Per-agent configuration for this capability (capability-specific)

**ref**

required

Reference to the capability ID

string

**description**

required

Short description

string

**dev_only**

required

Whether this example requires dev/experimental mode

boolean

**display_name**

required

Human-readable display name (e.g. “Dad Jokes Agent”)

string

**harness_name**

required

Explicit harness selected when importing this example.

string

**localizations**

required

Locale-keyed display names and descriptions.

object

**_key_**

additional properties

Display-only translations shared by portable agent files and platform resources. Addresses, tool identifiers and execution instructions never use these values.

object

**description**

Localized description (1–2000 characters when set).

string | null

**display_name**

Localized display name (1–255 characters when set).

string | null

**name**

required

Name (e.g. “dad-jokes-agent”)

string

**setup**

One of:

* object

  Guided setup to run after importing, for templates that need one.

  object

  **connect_github**

  required

  The agent needs its own GitHub App (`POST /v1/agents/{id}/github/connect`).

  boolean

  **connections**

  required

  Other connection providers the agent’s service account needs.

  Array\<string>

  **repository_placeholder**

  required

  Text in `trigger` to replace with the picked `owner/repo`.

  string

  **settings**

  required

  Yes/no choices, each stored as one capability config key.

  Array\<object>

  One setup choice. Turning it on sets `config_key` to `true` in the config of the agent’s `capability`.

  object

  **capability**

  required

  Capability whose configuration this option changes.

  string

  **config_key**

  required

  Boolean configuration property controlled by this option.

  string

  **default**

  required

  Initial value shown during guided setup.

  boolean

  **description**

  required

  Explains the effect of enabling this option.

  string

  **key**

  required

  Stable setup option key.

  string

  **label**

  required

  Human-readable setup option label.

  string

  **trigger**

  required

  Body for `POST /v1/agents/{agent_id}/triggers` once the placeholder is replaced.

  object

* null

  null

**tags**

required

Tags for categorization

Array\<string>

### Example

```json
[
  {
    "capabilities": [
      "current_time"
    ],
    "description": "A friendly agent that tells dad jokes and knows what time it is.",
    "dev_only": false,
    "display_name": "Dad Jokes Agent",
    "harness_name": "conversation",
    "name": "dad-jokes-agent",
    "setup": {
      "connect_github": true,
      "connections": [
        "daytona"
      ],
      "repository_placeholder": "${repository}",
      "settings": []
    },
    "tags": [
      "humor",
      "demo"
    ]
  }
]
```

FetchcURL

Request

```js
const url = 'https://app.everruns.com/api/v1/agent-examples';
const options = {method: 'GET'};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

Request

```sh
curl --request GET \
  --url https://app.everruns.com/api/v1/agent-examples
```

Additional language examples require JavaScript. The default request example is available above.

200

200 · List of agent examples

```json
[
  {
    "capabilities": [
      "current_time"
    ],
    "description": "A friendly agent that tells dad jokes and knows what time it is.",
    "dev_only": false,
    "display_name": "Dad Jokes Agent",
    "harness_name": "conversation",
    "localizations": {},
    "name": "dad-jokes-agent",
    "tags": [
      "humor",
      "demo"
    ]
  }
]
```

## Matching endpoints