---
title: "List uploads"
canonical_url: https://docs.zvid.io/docs/endpoints/list-uploads/
source: docs/endpoints/list-uploads.api.mdx
content_revision: 6338386a1dd87e4a
---

# List uploads

`GET /api/uploads`

Your hosted media library — files usable directly as element `src` URLs.

## Authentication

- Option 1: `x-api-key: YOUR_API_KEY` (header). API key for authentication. Create one in your dashboard.
- Option 2: `Authorization: Bearer YOUR_ACCESS_TOKEN`. Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.

Create API keys at [app.zvid.io/api-keys](https://app.zvid.io/api-keys). Keep credentials on your server.

## Parameters

| Parameter | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| `type` | query | `"image"` / `"video"` / `"audio"` / `"gif"` | No |  |

## Request

The shell examples read credentials from `ZVID_API_KEY` (or `ZVID_ACCESS_TOKEN` for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

### Request example

```bash
curl --request GET 'https://api.zvid.io/api/uploads' \
  --header "x-api-key: $ZVID_API_KEY"
```

## Responses


### HTTP 200

Uploaded files and storage usage

Content type: `application/json`.

Required properties: `uploads`, `usage`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.uploads` | array of [Upload](#schema-upload) | Yes |  |
| `response.usage` | [UploadUsage](#schema-upload-usage) | Yes |  |

**Nested field: `response.uploads`**

**Array item: `response.uploads[]`**

Schema: [Upload](#schema-upload).


**Representative successful response response**

```json
{
  "uploads": [],
  "usage": {
    "files": 0,
    "usedBytes": 0,
    "maxTotalBytes": 2147483648
  }
}
```

## Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.


### schema upload list

**UploadList**


Required properties: `uploads`, `usage`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `UploadList.uploads` | array of [Upload](#schema-upload) | Yes |  |
| `UploadList.usage` | [UploadUsage](#schema-upload-usage) | Yes |  |

**Nested field: `UploadList.uploads`**

**Array item: `UploadList.uploads[]`**

Schema: [Upload](#schema-upload).


### schema upload

**Upload**


Required properties: `id`, `kind`, `fileName`, `sizeBytes`, `url`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `Upload.id` | string | Yes |  |
| `Upload.kind` | `"image"` / `"video"` / `"audio"` / `"gif"` | Yes |  |
| `Upload.fileName` | string | Yes |  |
| `Upload.mimeType` | string | No |  |
| `Upload.sizeBytes` | integer | Yes |  |
| `Upload.width` | number OR null | No | At least one listed alternative must match. |
| `Upload.height` | number OR null | No | At least one listed alternative must match. |
| `Upload.duration` | number OR null | No | At least one listed alternative must match. |
| `Upload.url` | string | Yes |  |
| `Upload.createdAt` | string | No |  |

**Nested field: `Upload.width`**

At least one listed alternative must match.

**anyOf alternative 1**

Type: number.

**anyOf alternative 2**

Type: null.

**Nested field: `Upload.height`**

At least one listed alternative must match.

**anyOf alternative 1**

Type: number.

**anyOf alternative 2**

Type: null.

**Nested field: `Upload.duration`**

At least one listed alternative must match.

**anyOf alternative 1**

Type: number.

**anyOf alternative 2**

Type: null.


### schema upload usage

**UploadUsage**


Required properties: `files`, `usedBytes`, `maxTotalBytes`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `UploadUsage.files` | integer | Yes |  |
| `UploadUsage.usedBytes` | integer | Yes |  |
| `UploadUsage.maxTotalBytes` | integer | Yes |  |


## Related resources

- [OpenAPI specification](https://docs.zvid.io/openapi.yaml)
- [Project payload schema](https://docs.zvid.io/schemas/render-payload.schema.json)
- [Quick Start](https://docs.zvid.io/docs/quick-start/)
- [Authentication guide](https://docs.zvid.io/docs/authentication/)