---
title: "Reads one file."
---

> 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

`GET /v1/stores/{store}/assets/{asset}`

## Authentication

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

## Path parameters

- `store` (`getAsset.path.store`; string, required) — The store's id.
- `asset` (`getAsset.path.asset`; string, required)
  - minLength 1

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/assets/<asset>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/assets/<asset>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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>/assets/<asset>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads one file.

#### Example

```json
{
  "kept_kind": "string",
  "lineage": {
    "assets": 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
    },
    "deliveries": {
      "total": 0
    },
    "quota_bytes": 0
  },
  "bindings": "string",
  "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"
}
```

- `kept_kind` (`getAsset.response.200.kept_kind`; any of, required) — The kind a replace or a type change must keep: `pdf` for a lesson's slides, `video` for its video, `audio` for a podcast episode's audio; null when none holds one.
  - any of: `string`, `null`
- `lineage` (`getAsset.response.200.lineage`; object, required)
  - `assets` (`getAsset.response.200.lineage.assets`; number, required)
  - `uses` (`getAsset.response.200.lineage.uses`; object, required)
    - `items` (`getAsset.response.200.lineage.uses.items`; array<object>, required)
      - `attachment_id` (`getAsset.response.200.lineage.uses.items.attachment_id`; string, required)
      - `asset_id` (`getAsset.response.200.lineage.uses.items.asset_id`; string, required)
      - `role` (`getAsset.response.200.lineage.uses.items.role`; string, required)
      - `delivery` (`getAsset.response.200.lineage.uses.items.delivery`; string, required)
      - `target` (`getAsset.response.200.lineage.uses.items.target`; object, required)
        - `kind` (`getAsset.response.200.lineage.uses.items.target.kind`; string, required)
        - `id` (`getAsset.response.200.lineage.uses.items.target.id`; string, required)
      - `from_body` (`getAsset.response.200.lineage.uses.items.from_body`; boolean, required)
      - `detachable` (`getAsset.response.200.lineage.uses.items.detachable`; boolean, required)
      - `release` (`getAsset.response.200.lineage.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` (`getAsset.response.200.lineage.uses.total`; number, required)
    - `detachable` (`getAsset.response.200.lineage.uses.detachable`; number, required)
  - `deliveries` (`getAsset.response.200.lineage.deliveries`; object, required)
    - `total` (`getAsset.response.200.lineage.deliveries.total`; number, required)
  - `quota_bytes` (`getAsset.response.200.lineage.quota_bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
- `bindings` (`getAsset.response.200.bindings`; string, required)
- `transforms` (`getAsset.response.200.transforms`; array<object>, required)
  - `stage` (`getAsset.response.200.transforms.stage`; string, required)
  - `params` (`getAsset.response.200.transforms.params`; object, required)
    - `level` (`getAsset.response.200.transforms.params.level`; string, optional)
  - `position` (`getAsset.response.200.transforms.position`; number, required)
- `deliveries` (`getAsset.response.200.deliveries`; object, required)
  - `items` (`getAsset.response.200.deliveries.items`; array<object>, required)
    - `id` (`getAsset.response.200.deliveries.items.id`; string, required)
    - `asset_id` (`getAsset.response.200.deliveries.items.asset_id`; string, required)
    - `customer_id` (`getAsset.response.200.deliveries.items.customer_id`; any of, required)
      - any of: `string`, `null`
    - `member_id` (`getAsset.response.200.deliveries.items.member_id`; any of, required)
      - any of: `string`, `null`
    - `intent` (`getAsset.response.200.deliveries.items.intent`; string, required)
    - `channel` (`getAsset.response.200.deliveries.items.channel`; string, required)
    - `issued_at` (`getAsset.response.200.deliveries.items.issued_at`; any of, required)
      - any of: `string`, `null`
    - `expires_at` (`getAsset.response.200.deliveries.items.expires_at`; any of, required)
      - any of: `string`, `null`
    - `revoked_at` (`getAsset.response.200.deliveries.items.revoked_at`; any of, required)
      - any of: `string`, `null`
    - `max_uses` (`getAsset.response.200.deliveries.items.max_uses`; any of, required)
      - any of: `number`, `null`
    - `used_count` (`getAsset.response.200.deliveries.items.used_count`; number, required)
    - `used_at` (`getAsset.response.200.deliveries.items.used_at`; any of, required)
      - any of: `string`, `null`
    - `state` (`getAsset.response.200.deliveries.items.state`; string, required)
  - `total` (`getAsset.response.200.deliveries.total`; number, required)
- `uses` (`getAsset.response.200.uses`; object, required)
  - `items` (`getAsset.response.200.uses.items`; array<object>, required)
    - `attachment_id` (`getAsset.response.200.uses.items.attachment_id`; string, required)
    - `asset_id` (`getAsset.response.200.uses.items.asset_id`; string, required)
    - `role` (`getAsset.response.200.uses.items.role`; string, required)
    - `delivery` (`getAsset.response.200.uses.items.delivery`; string, required)
    - `target` (`getAsset.response.200.uses.items.target`; object, required)
      - `kind` (`getAsset.response.200.uses.items.target.kind`; string, required)
      - `id` (`getAsset.response.200.uses.items.target.id`; string, required)
    - `from_body` (`getAsset.response.200.uses.items.from_body`; boolean, required)
    - `detachable` (`getAsset.response.200.uses.items.detachable`; boolean, required)
    - `release` (`getAsset.response.200.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` (`getAsset.response.200.uses.total`; number, required)
  - `detachable` (`getAsset.response.200.uses.detachable`; number, required)
- `children` (`getAsset.response.200.children`; object, required)
  - `items` (`getAsset.response.200.children.items`; array<string>, required)
  - `total` (`getAsset.response.200.children.total`; number, required)
- `id` (`getAsset.response.200.id`; string, required)
- `locator` (`getAsset.response.200.locator`; any of, required)
  - any of: `string`, `null`
- `origin` (`getAsset.response.200.origin`; string, required)
- `custodian` (`getAsset.response.200.custodian`; string, required)
- `enforcement` (`getAsset.response.200.enforcement`; string, required)
- `mime` (`getAsset.response.200.mime`; any of, required)
  - any of: `string`, `null`
- `bytes` (`getAsset.response.200.bytes`; any of, required) — The file's size in bytes; null when it is charged nothing.
  - any of: `number`, `null`
- `quota_bytes` (`getAsset.response.200.quota_bytes`; number, required) — The file's size in bytes; zero when it is charged nothing.
- `name` (`getAsset.response.200.name`; string, required)
- `title` (`getAsset.response.200.title`; any of, required)
  - any of: `string`, `null`
- `ext` (`getAsset.response.200.ext`; any of, required)
  - any of: `string`, `null`
- `status` (`getAsset.response.200.status`; string, required)
- `optimized` (`getAsset.response.200.optimized`; boolean, required)
- `parent_id` (`getAsset.response.200.parent_id`; any of, required)
  - any of: `string`, `null`
- `redacted` (`getAsset.response.200.redacted`; boolean, required)
- `security` (`getAsset.response.200.security`; any of, required)
  - any of: `string`, `null`
- `description` (`getAsset.response.200.description`; any of, required)
  - any of: `string`, `null`
- `processed_at` (`getAsset.response.200.processed_at`; any of, required)
  - any of: `string`, `null`
- `metadata` (`getAsset.response.200.metadata`; object, required)
  - `width` (`getAsset.response.200.metadata.width`; integer, optional)
    - min 0
  - `height` (`getAsset.response.200.metadata.height`; integer, optional)
    - min 0
  - `duration` (`getAsset.response.200.metadata.duration`; number, optional) — Seconds, measured, so rarely whole.
  - `pages` (`getAsset.response.200.metadata.pages`; integer, optional)
    - min 0
  - `waveform` (`getAsset.response.200.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` (`getAsset.response.200.metadata.transcript`; object, optional)
    - `language` (`getAsset.response.200.metadata.transcript.language`; string, optional)
    - `confidence` (`getAsset.response.200.metadata.transcript.confidence`; number, optional)
  - `arguments` (`getAsset.response.200.metadata.arguments`; array<object>, optional) — What an MCP prompt asks for; only an authored prompt carries it.
    - `name` (`getAsset.response.200.metadata.arguments.name`; string, required)
    - `description` (`getAsset.response.200.metadata.arguments.description`; any of, required)
      - any of: `string`, `null`
    - `required` (`getAsset.response.200.metadata.arguments.required`; boolean, required)
    - `default` (`getAsset.response.200.metadata.arguments.default`; any of, required)
      - any of: `string`, `null`
    - `match` (`getAsset.response.200.metadata.arguments.match`; any of, required) — Pattern the whole value must match, diacritic-insensitive.
      - any of: `string`, `null`
    - `flags` (`getAsset.response.200.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` (`getAsset.response.200.metadata.arguments.message`; any of, required) — What a refused value is told instead of the default reason.
      - any of: `string`, `null`
    - `lenient` (`getAsset.response.200.metadata.arguments.lenient`; boolean, required)
- `created_at` (`getAsset.response.200.created_at`; any of, required)
  - any of: `string`, `null`

### 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` (`getAsset.response.default.type`; string, required)
  - format `uri`
- `title` (`getAsset.response.default.title`; string, required)
- `status` (`getAsset.response.default.status`; integer, required)
- `detail` (`getAsset.response.default.detail`; string, required)
- `code` (`getAsset.response.default.code`; string, optional)
- `context` (`getAsset.response.default.context`; object, optional)
- `reached_core` (`getAsset.response.default.reached_core`; boolean, optional)
- `core_answer` (`getAsset.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/get-asset/index.md
