# Story routes: create, get, list

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

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

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

### Story.create
Creates a Story. [Verb page](/business/nouns/story/create?interface=api).

```text
POST /{namespace}/stories
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `icp` | [ICP](/business/nouns/icp) | Yes | The ICP it speaks to: one Story per ICP. |
| `hero` | `text` | Yes | Who the customer is and what they want. |
| `problem` | [Problem](/business/nouns/problem) | Yes | The Problem: external, internal, and the villain behind it. |
| `guide` | `text` | No | The Startup’s empathy and authority, the authority read from Metrics and Evidence. |
| `plan` | `text` | No | Three steps, each naming a declared Event. |
| `success` | `text` | No | What the customer gains. |
| `failure` | `text` | No | What the customer risks without it. |
| `oneLiner` | `string` | No | The Story in one sentence. |
| `direct` | [Offer](/business/nouns/offer) | No | The direct call to action: an Offer that makes a Customer. |
| `transitional` | [Funnel](/business/nouns/funnel) | No | The transitional call to action: a Funnel opt-in that makes a Lead. |
| `from` | `string` | Yes | Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`. |
| `stance` | `string` | No | The positioning the Positioning tournament chose, graded Behavior; every compiled asset recompiles when it changes. |
| `category` | `string` | No | The market category name the Story claims, as answer engines repeat it. |
| `hypothesis` | [Hypothesis](/business/nouns/hypothesis) | No | The Founding Hypothesis whose slots the Story compiles from; a pivot recompiles it. |

**Returns**

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

**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/stories \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"icp":"icp_EwhsJU4AOW","hero":"Example hero","problem":"problem_UzvXXfKsJB","from":"Hypothesis#approach@v1"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "story": {
    "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
    "$type": "Story",
    "icp": "icp_EwhsJU4AOW",
    "hero": "Example hero",
    "problem": "problem_UzvXXfKsJB",
    "from": "Hypothesis#approach@v1"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Story.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

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

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Story",
  "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
  "story": {
    "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
    "$type": "Story",
    "icp": "icp_EwhsJU4AOW",
    "hero": "Example hero",
    "problem": "problem_UzvXXfKsJB",
    "from": "Hypothesis#approach@v1"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
    "up": "https://api.sb/leaseline.app/stories"
  }
}
```

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

```text
GET /{namespace}/stories
```

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 |
| --- | --- | --- | --- |
| `stories` | list of [Story](/business/nouns/story) | Yes | One page of Stories. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Story",
  "stories": [
    {
      "$id": "https://api.sb/leaseline.app/stories/story_ujkz1xjvrp",
      "$type": "Story",
      "icp": "icp_EwhsJU4AOW",
      "hero": "Example hero",
      "problem": "problem_UzvXXfKsJB",
      "from": "Hypothesis#approach@v1"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "story_ujkz1xjvrp"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/stories?limit=20",
    "next": "https://api.sb/leaseline.app/stories?after=story_ujkz1xjvrp"
  }
}
```