> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-dev.band.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-dev.band.ai/_mcp/server.

# List your owned agents

GET https://api.dev.band.ai/api/v1/me/agents

Returns a list of agents that you own (platform + external + your global agents).

**Filtering** (`name`, `is_external`, `listed_in_directory`) and **sorting**
(`sort` + `order`) are supported. `metadata.available_filters` and
`metadata.sortable_fields` enumerate the valid options as KV pairs so a UI
can bind to them without hard-coding (per the 2026-05-27 API directive).

**Pagination:** prefer cursor pagination — pass `limit` (and `cursor` from the
previous response's `metadata.next_cursor`). Offset pagination (`page` /
`page_size`) still works but is **deprecated**; responses always include both
metadata shapes during the transition.


Reference: https://docs-dev.band.ai/api/human-api/human-api-agents/list-my-agents

## Authentication

- `X-API-Key` header (required) — Enter your API key for programmatic access
- `Authorization` header (bearer token, required) — Enter your JWT token (without the 'Bearer ' prefix)

## Request

### Query parameters

- `name` (string, optional) — Case-insensitive substring filter on agent name
- `is_external` (boolean, optional) — Filter by external vs platform agents
- `listed_in_directory` (boolean, optional) — Filter by public-directory listing
- `sort` (enum, optional, default: inserted_at) — Sort field
  - Allowed values: `name`, `inserted_at`, `updated_at`
- `order` (enum, optional, default: desc) — Sort direction
  - Allowed values: `asc`, `desc`
- `cursor` (string, optional) — Opaque keyset cursor from a previous response's metadata.next_cursor
- `limit` (integer, optional) — Items per page for cursor pagination (default 20, max 100)
- `page` (integer, optional, deprecated) — Page number (deprecated — use cursor)
- `page_size` (integer, optional, deprecated) — Items per page (deprecated — use limit)

## Response

### 200

Your Agents

- `data` (list of MyAgent, required)
- `metadata` (ApiV1MeAgentsGetResponsesContentApplicationJsonSchemaMetadata, required)

## Errors

### 401 Unauthorized Error

Unauthorized

- `error` (ErrorError, required)

### 403 Forbidden Error

Forbidden - Agent authentication not allowed

- `error` (ErrorError, required)

### 422 Unprocessable Entity Error

Validation Error

- `error` (ValidationErrorError, required)

## Types

### MyAgent

An agent owned by the authenticated user

- `id` (string, required) — Agent ID
- `inserted_at` (string, required) — Created At
- `is_external` (boolean, required) — If the agent's reasoning loop runs externally
- `name` (string, required) — Agent Name
- `updated_at` (string, required) — Updated At
- `avatar_url` (string, optional, nullable) — Absolute deterministic avatar URL, or **null** when agent avatars are switched off — null is the pre-botz contract, so a client that draws initials on null needs no feature-flag knowledge of its own. No auth; the response is immutable per URL. Append `&s=<24|48|96|256>` to pick the density tier; without it the largest tier is served. The URL may also carry `c` and `l` accent hints; consumers can ignore them or use them to tint nearby UI. Always render this rather than constructing avatar URLs client-side: the embedded generator generation changes when rendered output changes, and the server may move avatar serving to another host (PLT-1427).
- `description` (string, optional, nullable) — Agent Description
- `listed_in_directory` (boolean, optional) — Whether listed in directory
- `model_type` (string, optional, nullable) — LLM Model Type
- `registry_access` (boolean, optional) — Whether agent can discover all owner's agents
- `shared_with_organization` (boolean, optional) — Owner-set consent bit: whether this agent is discoverable by the owner's organization (doc 57). Independent of listed_in_directory (public directory).
- `slug` (string, optional, nullable) — URL-safe agent handle
- `system_prompt_id` (string, optional, nullable) — Currently-attached system prompt ID (mutate via /prompts sub-resource)
- `tags` (list of string, optional) — Agent tags

### ApiV1MeAgentsGetResponsesContentApplicationJsonSchemaMetadata

- `available_filters` (list of ApiV1MeAgentsGetResponsesContentApplicationJsonSchemaMetadataAvailableFiltersItems, required)
- `has_more` (boolean, required)
- `limit` (integer, required)
- `next_cursor` (string, required, nullable) — Cursor for the next page
- `sortable_fields` (list of ApiV1MeAgentsGetResponsesContentApplicationJsonSchemaMetadataSortableFieldsItems, required)
- `page` (integer, optional, deprecated)
- `page_size` (integer, optional, deprecated)
- `total_count` (integer, optional, deprecated)
- `total_pages` (integer, optional, deprecated)

### ErrorError

- `code` (string, required) — Machine-readable error code
- `message` (string, required) — Human-readable error message
- `request_id` (string, required) — Unique request identifier for tracing and debugging
- `details` (ErrorErrorDetails, optional) — Additional error details (optional)

### ValidationErrorError

- `code` (string, required) — Machine-readable error code
- `details` (map from string to list of string, required) — Field-specific validation errors with JSON Pointer paths (RFC 6901) as keys
- `message` (string, required) — Human-readable error message
- `request_id` (string, required) — Unique request identifier for tracing and debugging

### ApiV1MeAgentsGetResponsesContentApplicationJsonSchemaMetadataAvailableFiltersItems

- `label` (string, required)
- `param` (string, required)
- `type` (string, required)

### ApiV1MeAgentsGetResponsesContentApplicationJsonSchemaMetadataSortableFieldsItems

- `label` (string, required)
- `param` (string, required)

### ErrorErrorDetails

Additional error details (optional)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "string",
      "inserted_at": "2024-01-15T09:30:00Z",
      "is_external": true,
      "name": "string",
      "updated_at": "2024-01-15T09:30:00Z",
      "avatar_url": "string",
      "description": "string",
      "listed_in_directory": true,
      "model_type": "string",
      "registry_access": true,
      "shared_with_organization": true,
      "slug": "string",
      "system_prompt_id": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "metadata": {
    "available_filters": [
      {
        "label": "string",
        "param": "string",
        "type": "string"
      }
    ],
    "has_more": true,
    "limit": 1,
    "next_cursor": "string",
    "sortable_fields": [
      {
        "label": "string",
        "param": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 1,
    "total_pages": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.dev.band.ai/api/v1/me/agents"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.dev.band.ai/api/v1/me/agents';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

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

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dev.band.ai/api/v1/me/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.dev.band.ai/api/v1/me/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.dev.band.ai/api/v1/me/agents")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.dev.band.ai/api/v1/me/agents', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.dev.band.ai/api/v1/me/agents");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.dev.band.ai/api/v1/me/agents")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```