# Idea routes

URL: /code/api/idea · Id: `page:code/api/idea`

> Every Idea Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for [Idea](/business/nouns/idea).

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

```text
POST /{namespace}/ideas
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `statement` | `text` | Yes | The concept in one line. |

**Returns**

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

**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/ideas \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"statement":"Tracks lease renewals for small property managers."}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "idea": {
    "$id": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L",
    "$type": "Idea",
    "statement": "Tracks lease renewals for small property managers.",
    "status": "open"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Idea.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

```text
GET /{namespace}/ideas/{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 Idea. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

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

**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/ideas/idea_912vmxR17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Idea",
  "$id": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L",
  "idea": {
    "$id": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L",
    "$type": "Idea",
    "statement": "Tracks lease renewals for small property managers.",
    "status": "open"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L",
    "up": "https://api.sb/leaseline.app/ideas"
  },
  "actions": {
    "pursue": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L/pursue"
  }
}
```

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

```text
GET /{namespace}/ideas
```

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 |
| --- | --- | --- | --- |
| `ideas` | list of [Idea](/business/nouns/idea) | Yes | One page of Ideas. |

**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/ideas?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Idea",
  "ideas": [
    {
      "$id": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L",
      "$type": "Idea",
      "statement": "Tracks lease renewals for small property managers.",
      "status": "open"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "idea_912vmxR17L"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/ideas?limit=20",
    "next": "https://api.sb/leaseline.app/ideas?after=idea_912vmxR17L"
  }
}
```

### Idea.pursue
Pursue starts a Startup on an Idea as one variant of the Experiment that tests the Idea. [Verb page](/business/nouns/idea/pursue?interface=api).

```text
POST /{namespace}/ideas/{idea}/pursue
```

Path: `idea`. Body, as JSON: the other inputs. Emits [`Idea.pursued`](/business/events/Idea.pursued).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `idea` | [Idea](/business/nouns/idea) | Yes | The Idea to pursue. |
| `template` | [Template](/business/nouns/template) | No | The Template the variant extends. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `startup` | [Startup](/business/nouns/startup) | Yes | The new variant Startup. |
| `idea` | [Idea](/business/nouns/idea) | Yes | The Idea now pursued. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The input does not match the schema of the operation. | [`invalid-input`](/code/api/errors/invalid-input) | Read the schema of the operation, then send every required field with the right type. | None. |
| 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/ideas/idea_912vmxR17L/pursue \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_VBluhMC0sH",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "idea": {
    "$id": "https://api.sb/leaseline.app/ideas/idea_912vmxR17L",
    "$type": "Idea",
    "statement": "Tracks lease renewals for small property managers.",
    "status": "open"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Idea.pursue",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```