> For the complete documentation index, see [llms.txt](https://docs.sunbirdrc.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sunbirdrc.dev/api-reference/file-storage-api/get-uploaded-file.md).

# Get Uploaded File

<mark style="color:blue;">`GET`</mark> `/api/v1/{entity-type}/{entity-id}/{property}/documents/{document-id}`

#### Path Parameters

| Name                                          | Type   | Description                                             |
| --------------------------------------------- | ------ | ------------------------------------------------------- |
| entity-type<mark style="color:red;">\*</mark> | String | Entity for which file was uploaded                      |
| entity-id<mark style="color:red;">\*</mark>   | String | Entity ID of corresponding entity                       |
| property<mark style="color:red;">\*</mark>    | String | any String for eg templates for uploading html template |
| document-id<mark style="color:red;">\*</mark> | String | ID of document that was uploaded                        |

#### Headers

| Name                                            | Type   | Description                                                                                        |
| ----------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------- |
| content-type<mark style="color:red;">\*</mark>  | String | Set to `application/octet-stream`                                                                  |
| authorization<mark style="color:red;">\*</mark> | String | Set to `Bearer {access-token}` if `roles` in schema config is not anonymous else this can be empty |

{% tabs %}
{% tab title="200: OK Success response of uploaded file" %}

```javascript
{file contents that was uploaded}
```

{% endtab %}
{% endtabs %}

## Usage

### cURL

```shell
curl --location \
    --request GET '{registry-url}/api/v1/{entity-type/{entity-id}/{property}/documents/{document-id}' \
    --header 'Authorization: Bearer {access-token}'
```

### HTTPie

```shell
http '{registry-url}/api/v1/{entity-type/{entity-id}/{property}/documents/{document-id}' \
 Authorization:'Bearer {access-token}'
```

> `{registry-url}` is usually [http://localhost:{port}](https://docs.sunbirdrc.dev/api-reference/file-storage-api/http:/localhost:{port}). The port can be found under the `registry` section in the `docker-compose.yml` file and is usually `8081`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sunbirdrc.dev/api-reference/file-storage-api/get-uploaded-file.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.