# Document routes: render

URL: /code/api/document/verbs · Id: `page:code/api/document/verbs`

> The Document Verbs render as api.sb routes, with inputs, result, refusals and an example.

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

### Document.render
Render produces a file from a Document in the format the reader asks for. [Verb page](/business/nouns/document/render?interface=api).

```text
POST /{namespace}/documents/{document}/render
```

Path: `document`. Body, as JSON: the other inputs. Emits [`Document.rendered`](/business/events/Document.rendered).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `document` | [Document](/business/nouns/document) | Yes | The Document to render. |
| `format` | `string` | Yes | The file format. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `file` | `url` | Yes | Where the file lives. |
| `document` | [Document](/business/nouns/document) | Yes | The Document rendered. |

**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/documents/document_af2wijcmRy/render \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"Example format"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "file": "https://leaseline.app",
  "document": {
    "$id": "https://api.sb/leaseline.app/documents/document_af2wijcmRy",
    "$type": "Document",
    "form": "document"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Document.render",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```