---
title: "Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › file

`POST /v1/stores/{store}/uploads`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `file:write`

## Path parameters

- `store` (`createUpload.path.store`; string, required) — The store's id.

## Request body

_Required._

- `name` (`createUpload.name`; string, required)
  - minLength 1; maxLength 200; pattern `^[a-z0-9][a-z0-9-]*$`
- `mime` (`createUpload.mime`; string, required)
  - minLength 1; maxLength 128; pattern `^[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*$`
- `bytes` (`createUpload.bytes`; integer, required) — The file's size in bytes, as the upload sends it.
  - min 1; max 5363466240
- `title` (`createUpload.title`; any of, optional)
  - any of: `string`, `null`
- `ext` (`createUpload.ext`; any of, optional) — The file's own extension; the mime's usual one when absent or null.
  - any of: `string`, `null`
- `enforcement` (`createUpload.enforcement`; string, optional) — How the file is served: `public` to anyone with its link, `signed` (the default) only through links that expire.
  - one of `"public"`, `"signed"`

## Example request

```json
{
  "name": "string",
  "title": "string",
  "mime": "string",
  "bytes": 1,
  "ext": "string",
  "enforcement": "public"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/uploads' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "title": "string",
  "mime": "string",
  "bytes": 1,
  "ext": "string",
  "enforcement": "public"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/uploads';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    name: 'string',
    title: 'string',
    mime: 'string',
    bytes: 1,
    ext: 'string',
    enforcement: 'public'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/uploads"

payload = {
    "name": "string",
    "title": "string",
    "mime": "string",
    "bytes": 1,
    "ext": "string",
    "enforcement": "public"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.

#### Example

```json
{
  "asset": {
    "transforms": [
      {
        "stage": "string",
        "params": {
          "level": "string",
          "property1": true,
          "property2": true
        },
        "position": 0
      }
    ],
    "deliveries": {
      "items": [
        {
          "id": "string",
          "asset_id": "string",
          "customer_id": "string",
          "member_id": "string",
          "intent": "string",
          "channel": "string",
          "issued_at": "string",
          "expires_at": "string",
          "revoked_at": "string",
          "max_uses": 0,
          "used_count": 0,
          "used_at": "string",
          "state": "string"
        }
      ],
      "total": 0
    },
    "uses": {
      "items": [
        {
          "attachment_id": "string",
          "asset_id": "string",
          "role": "string",
          "delivery": "string",
          "target": {
            "kind": "string",
            "id": "string"
          },
          "from_body": true,
          "detachable": true,
          "release": {
            "id": "string",
            "version": "string",
            "current": true,
            "after": {
              "id": "string",
              "version": "string"
            }
          }
        }
      ],
      "total": 0,
      "detachable": 0
    },
    "children": {
      "items": [
        "string"
      ],
      "total": 0
    },
    "id": "string",
    "locator": "string",
    "origin": "string",
    "custodian": "string",
    "enforcement": "string",
    "mime": "string",
    "bytes": 0,
    "quota_bytes": 0,
    "name": "string",
    "title": "string",
    "ext": "string",
    "status": "string",
    "optimized": true,
    "parent_id": "string",
    "redacted": true,
    "security": "string",
    "description": "string",
    "processed_at": "string",
    "metadata": {
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "waveform": "string",
      "transcript": {
        "language": "string",
        "confidence": 0
      },
      "arguments": [
        {
          "name": "string",
          "description": "string",
          "required": true,
          "default": "string",
          "match": "string",
          "flags": "string",
          "message": "string",
          "lenient": true
        }
      ],
      "property1": true,
      "property2": true
    },
    "created_at": "string"
  },
  "upload": {
    "url": "string",
    "method": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "expires_at": "string"
  }
}
```

- `asset` (`createUpload.response.201.asset`; object, required)
  - `transforms` (`createUpload.response.201.asset.transforms`; array<object>, required)
    - `stage` (`createUpload.response.201.asset.transforms.stage`; string, required)
    - `params` (`createUpload.response.201.asset.transforms.params`; object, required)
      - `level` (`createUpload.response.201.asset.transforms.params.level`; string, optional)
    - `position` (`createUpload.response.201.asset.transforms.position`; number, required)
  - `deliveries` (`createUpload.response.201.asset.deliveries`; object, required)
    - `items` (`createUpload.response.201.asset.deliveries.items`; array<object>, required)
      - `id` (`createUpload.response.201.asset.deliveries.items.id`; string, required)
      - `asset_id` (`createUpload.response.201.asset.deliveries.items.asset_id`; string, required)
      - `customer_id` (`createUpload.response.201.asset.deliveries.items.customer_id`; any of, required)
        - any of: `string`, `null`
      - `member_id` (`createUpload.response.201.asset.deliveries.items.member_id`; any of, required)
        - any of: `string`, `null`
      - `intent` (`createUpload.response.201.asset.deliveries.items.intent`; string, required)
      - `channel` (`createUpload.response.201.asset.deliveries.items.channel`; string, required)
      - `issued_at` (`createUpload.response.201.asset.deliveries.items.issued_at`; any of, required)
        - any of: `string`, `null`
      - `expires_at` (`createUpload.response.201.asset.deliveries.items.expires_at`; any of, required)
        - any of: `string`, `null`
      - `revoked_at` (`createUpload.response.201.asset.deliveries.items.revoked_at`; any of, required)
        - any of: `string`, `null`
      - `max_uses` (`createUpload.response.201.asset.deliveries.items.max_uses`; any of, required)
        - any of: `number`, `null`
      - `used_count` (`createUpload.response.201.asset.deliveries.items.used_count`; number, required)
      - `used_at` (`createUpload.response.201.asset.deliveries.items.used_at`; any of, required)
        - any of: `string`, `null`
      - `state` (`createUpload.response.201.asset.deliveries.items.state`; string, required)
    - `total` (`createUpload.response.201.asset.deliveries.total`; number, required)
  - `uses` (`createUpload.response.201.asset.uses`; object, required)
    - `items` (`createUpload.response.201.asset.uses.items`; array<object>, required)
      - `attachment_id` (`createUpload.response.201.asset.uses.items.attachment_id`; string, required)
      - `asset_id` (`createUpload.response.201.asset.uses.items.asset_id`; string, required)
      - `role` (`createUpload.response.201.asset.uses.items.role`; string, required)
      - `delivery` (`createUpload.response.201.asset.uses.items.delivery`; string, required)
      - `target` (`createUpload.response.201.asset.uses.items.target`; object, required)
        - `kind` (`createUpload.response.201.asset.uses.items.target.kind`; string, required)
        - `id` (`createUpload.response.201.asset.uses.items.target.id`; string, required)
      - `from_body` (`createUpload.response.201.asset.uses.items.from_body`; boolean, required)
      - `detachable` (`createUpload.response.201.asset.uses.items.detachable`; boolean, required)
      - `release` (`createUpload.response.201.asset.uses.items.release`; any of, required) — The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.
        - any of: `object`, `null`
    - `total` (`createUpload.response.201.asset.uses.total`; number, required)
    - `detachable` (`createUpload.response.201.asset.uses.detachable`; number, required)
  - `children` (`createUpload.response.201.asset.children`; object, required)
    - `items` (`createUpload.response.201.asset.children.items`; array<string>, required)
    - `total` (`createUpload.response.201.asset.children.total`; number, required)
  - `id` (`createUpload.response.201.asset.id`; string, required)
  - `locator` (`createUpload.response.201.asset.locator`; any of, required)
    - any of: `string`, `null`
  - `origin` (`createUpload.response.201.asset.origin`; string, required)
  - `custodian` (`createUpload.response.201.asset.custodian`; string, required)
  - `enforcement` (`createUpload.response.201.asset.enforcement`; string, required)
  - `mime` (`createUpload.response.201.asset.mime`; any of, required)
    - any of: `string`, `null`
  - `bytes` (`createUpload.response.201.asset.bytes`; any of, required) — The file's size in bytes; null when it is charged nothing.
    - any of: `number`, `null`
  - `quota_bytes` (`createUpload.response.201.asset.quota_bytes`; number, required) — The file's size in bytes; zero when it is charged nothing.
  - `name` (`createUpload.response.201.asset.name`; string, required)
  - `title` (`createUpload.response.201.asset.title`; any of, required)
    - any of: `string`, `null`
  - `ext` (`createUpload.response.201.asset.ext`; any of, required)
    - any of: `string`, `null`
  - `status` (`createUpload.response.201.asset.status`; string, required)
  - `optimized` (`createUpload.response.201.asset.optimized`; boolean, required)
  - `parent_id` (`createUpload.response.201.asset.parent_id`; any of, required)
    - any of: `string`, `null`
  - `redacted` (`createUpload.response.201.asset.redacted`; boolean, required)
  - `security` (`createUpload.response.201.asset.security`; any of, required)
    - any of: `string`, `null`
  - `description` (`createUpload.response.201.asset.description`; any of, required)
    - any of: `string`, `null`
  - `processed_at` (`createUpload.response.201.asset.processed_at`; any of, required)
    - any of: `string`, `null`
  - `metadata` (`createUpload.response.201.asset.metadata`; object, required)
    - `width` (`createUpload.response.201.asset.metadata.width`; integer, optional)
      - min 0
    - `height` (`createUpload.response.201.asset.metadata.height`; integer, optional)
      - min 0
    - `duration` (`createUpload.response.201.asset.metadata.duration`; number, optional) — Seconds, measured, so rarely whole.
    - `pages` (`createUpload.response.201.asset.metadata.pages`; integer, optional)
      - min 0
    - `waveform` (`createUpload.response.201.asset.metadata.waveform`; any of, optional) — An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.
      - any of: `string`, `null`
    - `transcript` (`createUpload.response.201.asset.metadata.transcript`; object, optional)
      - `language` (`createUpload.response.201.asset.metadata.transcript.language`; string, optional)
      - `confidence` (`createUpload.response.201.asset.metadata.transcript.confidence`; number, optional)
    - `arguments` (`createUpload.response.201.asset.metadata.arguments`; array<object>, optional) — What an MCP prompt asks for; only an authored prompt carries it.
      - `name` (`createUpload.response.201.asset.metadata.arguments.name`; string, required)
      - `description` (`createUpload.response.201.asset.metadata.arguments.description`; any of, required)
        - any of: `string`, `null`
      - `required` (`createUpload.response.201.asset.metadata.arguments.required`; boolean, required)
      - `default` (`createUpload.response.201.asset.metadata.arguments.default`; any of, required)
        - any of: `string`, `null`
      - `match` (`createUpload.response.201.asset.metadata.arguments.match`; any of, required) — Pattern the whole value must match, diacritic-insensitive.
        - any of: `string`, `null`
      - `flags` (`createUpload.response.201.asset.metadata.arguments.flags`; any of, required) — Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.
        - any of: `string`, `null`
      - `message` (`createUpload.response.201.asset.metadata.arguments.message`; any of, required) — What a refused value is told instead of the default reason.
        - any of: `string`, `null`
      - `lenient` (`createUpload.response.201.asset.metadata.arguments.lenient`; boolean, required)
  - `created_at` (`createUpload.response.201.asset.created_at`; any of, required)
    - any of: `string`, `null`
- `upload` (`createUpload.response.201.upload`; object, required)
  - `url` (`createUpload.response.201.upload.url`; string, required)
  - `method` (`createUpload.response.201.upload.method`; string, required)
  - `headers` (`createUpload.response.201.upload.headers`; map<string>, required)
  - `expires_at` (`createUpload.response.201.upload.expires_at`; string, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`createUpload.response.default.type`; string, required)
  - format `uri`
- `title` (`createUpload.response.default.title`; string, required)
- `status` (`createUpload.response.default.status`; integer, required)
- `detail` (`createUpload.response.default.detail`; string, required)
- `code` (`createUpload.response.default.code`; string, optional)
- `context` (`createUpload.response.default.context`; object, optional)
- `reached_core` (`createUpload.response.default.reached_core`; boolean, optional)
- `core_answer` (`createUpload.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/create-upload/index.md
