---
title: "files: download"
description: "a file's pointer from a task or a document, and where in the workspace to put it to progress by bytes moved of bytes in all, then the path inside the workspace"
section: reference
address: /reference/files/download
contract: 0476e35e6e275db5
---
# files: download
a file's pointer from a task or a document, and where in the workspace to put it to progress by bytes moved of bytes in all, then the path inside the workspace
[figure: The caller sends DownloadInput to /v1/files/download. The platform returns a card whose body is FileTransfer.]
POST/v1/files/downloada task, 202
From the local server's own. The call needs the user rung under a token with the files grant, and it is served by the installed app.
The route takes [DownloadInput](/concepts/downloadinput) and returns a card whose body is [FileTransfer](/concepts/filetransfer).
## Request body
The request body is [DownloadInput](/concepts/downloadinput).
| field | type | required | note |
|---|---|---|---|
| `pointer` | `id` | yes | |
| `into` | `text` | no | |
## Response
The route returns a card whose body is [FileTransfer](/concepts/filetransfer). Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true. This route runs as a long step and returns a task with status 202. `POST /v1/work/status` returns the task's progress, and `POST /v1/work/cancel` stops the task.
## Headers
| header | required | meaning |
|---|---|---|
| `Scale-Scope` | yes | the scope the call runs in: tenant/, then /brand/, then /strategy/ |
| `Scale-As-True-On` | no | the date the facts must have been true on; defaults to now |
| `Scale-As-Known-On` | no | the date the facts must have been known on; defaults to now |
| `Scale-Key` | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the user rung and a token with the files grant. The desktop app serves this route.
## Example
The example sends the smallest body that DownloadInput allows. The build validates it against the schema of DownloadInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/files/download \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "pointer": "…" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.files.download({
"pointer": "…"
});
// answer.body is a FileTransfer. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/files/download",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"pointer": "…"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/files/download")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&DownloadInput { /* the fields of the page */ }).send().await?.json().await?;
```