---
title: "Get attachment URL"
description: "Mints a short-lived URL to an attachment's file, where the customer may reach it."
---

> 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.

# Get attachment URL

Needs the read scope.

## Call

- Tool: `get_attachment_url`
- Scope: `read`
- Writes, adding without changing what is there.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `attachment` | `string` | Yes |  |
| `renew` | `boolean` | No |  |
| `intent` | `"download" or "view"` | No | For a lesson's slides or a PDF a text shows: shown in the viewer as uploaded, or slides downloaded at their protection where the caller may; none serves them as bound. |
| `track` | `string` | No | One of the video's `tracks`, served inline to whoever may play the video. |
| `preview` | `string` | No | A token a seller made for a product's or a page's page, which opens the files its read lists unpublished, gated as ever. |

```json
{
  "type": "object",
  "properties": {
    "attachment": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "renew": {
      "type": "boolean"
    },
    "intent": {
      "description": "For a lesson's slides or a PDF a text shows: shown in the viewer as uploaded, or slides downloaded at their protection where the caller may; none serves them as bound.",
      "type": "string",
      "enum": [
        "download",
        "view"
      ]
    },
    "track": {
      "description": "One of the video's `tracks`, served inline to whoever may play the video.",
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "preview": {
      "description": "A token a seller made for a product's or a page's page, which opens the files its read lists unpublished, gated as ever.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "attachment"
  ],
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | `string` | Yes |  |
| `expires_at` | `string or null` | Yes |  |
| `intent` | `string or null` | Yes | What the URL is for: shown, saved or played; null for a link or public bytes, which open as they are. |

The answer's full shape is on [its API reference page](/customer-api/reference/get-attachment-url).

A file anyone may open, such as a link or a public file viewed inline, comes back as its URL. Any other, such as a private file or a download asked for as `attachment`, comes back inside the tool result as an embedded resource: a text file as `text`, any other as base64 in `blob`, up to 8 MiB; a larger one is an error.

Source: https://docs.sherpo.io/customer-mcp/tools/get_attachment_url/index.mdx
