# upload.getFile

Returns content of a whole file or its part.

## Example

{% tabs %}
{% tab title="Javascript" %}

```javascript
const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.upload.getFile({
        precise: true,
        cdnSupported: true,
        location: new Api.InputFileLocation({...}),
        offset: 2632318,
        limit: 9694460,
        }));
    console.log(result); // prints the result
})();
```

{% endtab %}

{% tab title="TypeScript" %}

```typescript
import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.upload.File = await client.invoke(new Api.upload.getFile({
        precise: true,
        cdnSupported: true,
        location: new Api.InputFileLocation({...}),
        offset: 2632318,
        limit: 9694460,
        }));
    console.log(result); // prints the result
})();
```

{% endtab %}
{% endtabs %}

## TL schema

```
upload.file#96a18d5 type:storage.FileType mtime:int bytes:bytes = upload.File;
upload.fileCdnRedirect#f18cda44 dc_id:int file_token:bytes encryption_key:bytes encryption_iv:bytes file_hashes:Vector<FileHash> = upload.File;
---functions---
upload.getFile#b15a9afc flags:# precise:flags.0?true cdn_supported:flags.1?true location:InputFileLocation offset:int limit:int = upload.File;
```

## Parameters

|        Name        | Type                                                                                                                              | Description                                                                                             |
| :----------------: | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|      **flags**     | [#](https://core.telegram.org/type/%23)                                                                                           | Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields) |
|     **precise**    | [flags](https://core.telegram.org/mtproto/TL-combinators#conditional-fields).0?[true](https://core.telegram.org/constructor/true) | Disable some checks on limit and offset values, useful for example to stream videos by keyframes        |
| **cdn\_supported** | [flags](https://core.telegram.org/mtproto/TL-combinators#conditional-fields).1?[true](https://core.telegram.org/constructor/true) | Whether the current client supports [CDN downloads](https://core.telegram.org/cdn)                      |
|    **location**    | [InputFileLocation](https://core.telegram.org/type/InputFileLocation)                                                             | File location                                                                                           |
|     **offset**     | [int](https://core.telegram.org/type/int)                                                                                         | Number of bytes to be skipped                                                                           |
|      **limit**     | [int](https://core.telegram.org/type/int)                                                                                         | Number of bytes to be returned                                                                          |

## Result

[upload.File](https://core.telegram.org/type/upload.File)

## Possible errors

| Code | Type                     | Description                                                                                                      |
| :--: | ------------------------ | ---------------------------------------------------------------------------------------------------------------- |
|  401 | AUTH\_KEY\_PERM\_EMPTY   | The temporary auth key must be binded to the permanent auth key to use these methods.                            |
|  400 | CHANNEL\_INVALID         | The provided channel is invalid                                                                                  |
|  400 | CHANNEL\_PRIVATE         | You haven't joined this channel/supergroup                                                                       |
|  406 | FILEREF\_UPGRADE\_NEEDED | The client has to be updated in order to support [file references](https://core.telegram.org/api/file_reference) |
|  400 | FILE\_ID\_INVALID        | The provided file id is invalid                                                                                  |
|  400 | FILE\_REFERENCE\_\*      | The file reference expired, it [must be refreshed](https://core.telegram.org/api/file_reference)                 |
|  400 | FILE\_REFERENCE\_EXPIRED | File reference expired, it must be refetched as described in <https://core.telegram.org/api/file_reference>      |
|  400 | LIMIT\_INVALID           | The provided limit is invalid                                                                                    |
|  400 | LOCATION\_INVALID        | The provided location is invalid                                                                                 |
|  400 | MSG\_ID\_INVALID         | Invalid message ID provided                                                                                      |
|  400 | OFFSET\_INVALID          | The provided offset is invalid                                                                                   |
|  400 | PEER\_ID\_INVALID        | The provided peer id is invalid                                                                                  |

## Can bots use this methd ?

### yes

## Related pages

### [Encrypted CDNs for Speed and Security](https://core.telegram.org/cdn)

How to handle file references.

### [File references](https://core.telegram.org/api/file_reference)

How to handle file references.