# Agent routes: create, get, list

URL: /code/api/agent/records · Id: `page:code/api/agent/records`

> The Agent Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for [Agent](/business/nouns/agent), one group of [Agent routes](/code/api/agent).

### Agent.create
Creates an Agent. [Verb page](/business/nouns/agent/create?interface=api).

```text
POST /{namespace}/agents
```

Body, as JSON: the inputs. Emits `Agent.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `instructions` | `text` | Yes | What the Agent does and how. |
| `model` | `string` | Yes | The model the Agent runs on. |
| `tools` | `string[]` | No | The tools the Agent may call. |
| `skills` | list of [Skill](/business/nouns/skill) | No | The Skills it loads. |
| `memory` | `string` | No | One of `tenant` (one Memory per Customer Tenant) or `startup` (one Memory for the Startup). |
| `maxSteps` | `integer` | No | The most steps one Task may take. |
| `budget` | `money` | No | The most one Task may spend; the Mandate’s Limits apply as well. |
| `handoffs` | list of [Role](/business/nouns/role) | No | The Roles it hands work to. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `agent` | [Agent](/business/nouns/agent) | Yes | The Agent. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/agents \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instructions":"Example instructions","model":"Example model"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "agent": {
    "$id": "https://api.sb/leaseline.app/agents/agent_02y6sojE6k",
    "$type": "Agent",
    "instructions": "Example instructions",
    "model": "Example model",
    "status": "standby"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Agent.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Agent.get
Returns one Agent by id. [Verb page](/business/nouns/agent/get?interface=api).

```text
GET /{namespace}/agents/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Agent. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `agent` | [Agent](/business/nouns/agent) | Yes | The Agent. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/agents/agent_tCzKDMorKn \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Agent",
  "$id": "https://api.sb/leaseline.app/agents/agent_tCzKDMorKn",
  "agent": {
    "$id": "https://api.sb/leaseline.app/agents/agent_tCzKDMorKn",
    "$type": "Agent",
    "instructions": "Write as the property manager’s assistant. Never promise a rent the manager has not set.",
    "model": "claude-opus-5-5",
    "status": "seated"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/agents/agent_tCzKDMorKn",
    "up": "https://api.sb/leaseline.app/agents"
  },
  "actions": {
    "resume": "https://api.sb/leaseline.app/agents/agent_tCzKDMorKn/resume",
    "retire": "https://api.sb/leaseline.app/agents/agent_tCzKDMorKn/retire"
  }
}
```

### Agent.list
Returns Agents, newest first, one page at a time. [Verb page](/business/nouns/agent/list?interface=api).

```text
GET /{namespace}/agents
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `agents` | list of [Agent](/business/nouns/agent) | Yes | One page of Agents. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/agents?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Agent",
  "agents": [
    {
      "$id": "https://api.sb/leaseline.app/agents/agent_tCzKDMorKn",
      "$type": "Agent",
      "instructions": "Write as the property manager’s assistant. Never promise a rent the manager has not set.",
      "model": "claude-opus-5-5",
      "status": "seated"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "agent_tCzKDMorKn"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/agents?limit=20",
    "next": "https://api.sb/leaseline.app/agents?after=agent_tCzKDMorKn"
  }
}
```