# File routes: create, get, list

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

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

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

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

```text
POST /{namespace}/files
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `contentType` | `string` | Yes | The media type, such as `application/pdf`. |
| `size` | `integer` | Yes | The size in bytes. |
| `name` | `string` | No | The file name it was uploaded with. |
| `visibility` | `string` | No | Who may read it: `Owner`, `Customer`, or `Public`. The default is `Owner`. |
| `document` | [Document](/business/nouns/document) | No | Each rendering of a Document to a format, such as PDF, is stored as a File. |

**Returns**

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

**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/files \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contentType":"Example content type","size":1}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "file": {
    "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
    "$type": "File",
    "contentType": "Example content type",
    "size": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "File.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

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

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "File",
  "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
  "file": {
    "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
    "$type": "File",
    "contentType": "Example content type",
    "size": 1
  },
  "links": {
    "self": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
    "up": "https://api.sb/leaseline.app/files"
  },
  "actions": {
    "edit": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH/edit"
  }
}
```

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

```text
GET /{namespace}/files
```

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 |
| --- | --- | --- | --- |
| `files` | list of [File](/business/nouns/file) | Yes | One page of Files. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "File",
  "files": [
    {
      "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
      "$type": "File",
      "contentType": "Example content type",
      "size": 1
    }
  ],
  "meta": {
    "limit": 20,
    "after": "file_V1AuhyCTsH"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/files?limit=20",
    "next": "https://api.sb/leaseline.app/files?after=file_V1AuhyCTsH"
  }
}
```