# Idea methods

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

> Every Idea Verb as a typed SDK method, 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=sdk).

```ts
interface IdeaVerbs {
  create(input: IdeaCreateInput, options?: SB.CallOptions): SB.Call<Idea>
}
```

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**

```ts
import { $ } from 'startup-builder'

const idea = await $.Idea.create({ statement: 'Tracks lease renewals for small property managers.' })
```

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

```ts
interface IdeaVerbs {
  get(input: IdeaGetInput, options?: SB.CallOptions): SB.Call<Idea>
}
```

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**

```ts
import { $ } from 'startup-builder'

const idea = await $.Idea.get({ id: 'idea_912vmxR17L' })
```

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

```ts
interface IdeaVerbs {
  list(input?: IdeaListInput, options?: SB.CallOptions): SB.ListCall<Idea>
}
```

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**

```ts
import { $ } from 'startup-builder'

const ideas = await $.Idea.list({ limit: 20 })
```

### 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=sdk).

```ts
interface IdeaVerbs {
  pursue(input: IdeaPursueInput, options?: SB.CallOptions): SB.Call<IdeaPursueOutput>
}
```

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**

```ts
import { $ } from 'startup-builder'

const { startup, idea } = await $.Idea.pursue({ idea: 'idea_912vmxR17L' })
```