Skip to content

Get file URL

Mints a short-lived URL to a file's bytes.

Needs the file:read scope.

Call

  • Tool: get_asset_url
  • Scope: file:read
  • Writes, adding without changing what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
asset object Yes
disposition "inline" or "attachment" No
expires_in integer No
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "asset": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "disposition": {
      "type": "string",
      "enum": [
        "inline",
        "attachment"
      ]
    },
    "expires_in": {
      "type": "integer",
      "minimum": 1,
      "maximum": 604800
    }
  },
  "required": [
    "asset"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
url string Yes
expires_at string or null Yes

The answer’s full shape is on its API reference page.

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.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • conflict: the call clashes with the current state; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo. One marked transient failed fetching the file. A retry only hands out another link (a download is recorded as one more delivery), so it may be called again.
  • client-fault: the server failed around the call. reached_core says whether it reached Sherpo; the call may be made again.
  • invalid: the file is larger than 8 MiB, past what a tool result carries.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close