---
title: "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

## Operations

- [Lists the files attached to a resource.](/merchant-api/reference/list-attachments/)
- [Attaches a file to a resource in a role.](/merchant-api/reference/attach-asset/)
- [Answers what a save takes for a kind of body: its block types, each block's props with their types, values and limits, which are required, and where blocks may sit.](/merchant-api/reference/get-body-schema/)
- [Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. \`getBodySchema\` answers the blocks and props each kind of body takes.](/merchant-api/reference/read-body/)
- [Writes the live body of the store's home, a page, a product or an entry, or with \`staged: true\` its unpublished next body, which \`publishBody\` publishes; \`from\` names the body read, so a write over one changed since is refused. Ask \`getBodySchema\` for the blocks, props and values its kind takes before writing: anything else is refused, naming the block, the prop and what it takes.](/merchant-api/reference/set-body/)
- [Updates, inserts, moves or deletes blocks of a body by id, without sending it whole. \`getBodySchema\` answers the props each block takes.](/merchant-api/reference/edit-body/)
- [Publishes the staged body.](/merchant-api/reference/publish-body/)
- [Discards the staged body, keeping the published one.](/merchant-api/reference/discard-staged/)
- [Updates an attachment's role, delivery or preview flag.](/merchant-api/reference/update-attachment/)
- [Sets the order of a resource's attachments.](/merchant-api/reference/reorder-attachments/)
- [Detaches a file from a resource, keeping the file.](/merchant-api/reference/detach-attachment/)
- [Pages a product's MCP prompts with their text.](/merchant-api/reference/list-prompts/)
- [Adds an MCP prompt to a product.](/merchant-api/reference/create-prompt/)
- [Reads one of a product's MCP prompts.](/merchant-api/reference/get-prompt/)
- [Deletes an MCP prompt.](/merchant-api/reference/delete-prompt/)
- [Updates an MCP prompt's fields, text or access.](/merchant-api/reference/update-prompt/)
- [Sets, swaps or clears a product's thumbnail, its first poster, if it is still the one the caller saw.](/merchant-api/reference/set-product-poster/)
- [Pages the store's files.](/merchant-api/reference/list-assets/)
- [Creates a link file, such as an external video.](/merchant-api/reference/create-asset/)
- [Reads one file.](/merchant-api/reference/get-asset/)
- [Deletes a file nothing uses.](/merchant-api/reference/delete-asset/)
- [Updates a file's name, title, description and security level.](/merchant-api/reference/update-asset/)
- [Reads the store's storage use against its plan's allowance, and the time zone its files' deliveries are dated in.](/merchant-api/reference/get-quota/)
- [Lists a video's or audio file's AI outputs (subtitles, transcript, summary, chapters) and where each one's generation stands.](/merchant-api/reference/list-media-outputs/)
- [Reads one of a video's or audio file's AI outputs with its content.](/merchant-api/reference/get-media-output/)
- [Deletes one of a video's or audio file's AI outputs.](/merchant-api/reference/delete-media-output/)
- [Edits one of a video's or audio file's AI outputs: the subtitles' cues, or the transcript's, summary's or chapters' content.](/merchant-api/reference/update-media-output/)
- [Generates one of a video's or audio file's AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.](/merchant-api/reference/generate-media-output/)
- [Publishes one of a video's or audio file's AI outputs to customers, or takes it back to a draft.](/merchant-api/reference/publish-media-output/)
- [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.](/merchant-api/reference/create-upload/)
- [Uploads a file of at most 2 MiB with its bytes in the call, for a client that cannot send them to an upload URL.](/merchant-api/reference/create-inline-upload/)
- [Marks an upload done once its bytes are in place.](/merchant-api/reference/complete-upload/)
- [Cancels an upload that was never completed.](/merchant-api/reference/cancel-upload/)
- [Mints a short-lived URL to a file's bytes.](/merchant-api/reference/get-asset-url/)
- [Moves a file between public and private storage.](/merchant-api/reference/move-asset/)
- [Replaces a file's bytes with another upload's, keeping where it is used and deleting a video's or audio file's AI outputs.](/merchant-api/reference/replace-asset/)
- [Counts a product's files and links by kind.](/merchant-api/reference/product-file-stats/)
- [Pages the deliveries of files from the last year, newest first, with the file, who it went to and its state, in the store's time zone.](/merchant-api/reference/list-asset-deliveries/)
- [Pages where files are used.](/merchant-api/reference/list-asset-uses/)
- [Answers the bytes of a private file a capability names, to the bearer that asked for it.](/merchant-api/reference/get-file/)


Source: https://docs.sherpo.io/merchant-api/reference/tags/file/index.md
