Skip to content

Attach file

Attaches a file to a resource in a role.

Needs the file:write scope.

Call

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

Arguments

Name Type Required Description
store string No The store to act on.
target object Yes
asset object Yes
role "body" or "staged" or "staged_file" or "prose" or "teaser" or "embed" or "deliverable" or "poster" or "logo" or "prompt" or "stylesheet" Yes A poster takes an image only, a logo an image and a stylesheet CSS; a poster, and an image a product binds as embed, at most 15 MB. The store’s home takes only body and stylesheet, one of each; its body binds the files it names.
delivery "inline" or "download" or "stream" No
preview_only boolean No
position integer No
if_none boolean No Refused when the target already holds one in this role.
if_none_of "video" or "audio" or "pdf" No Refused while the target holds a file of this kind in the role that its body didn’t bind; the asset must be one, or it refuses conflict on mime with the reason.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "target": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "product",
            "entry",
            "store",
            "quiz",
            "certificate",
            "holding",
            "page"
          ]
        },
        "id": {
          "description": "Required but for the store's home, which takes the store's own id or none.",
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "kind"
      ],
      "additionalProperties": false
    },
    "asset": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "role": {
      "description": "A `poster` takes an image only, a `logo` an image and a `stylesheet` CSS; a poster, and an image a product binds as `embed`, at most 15 MB. The store's home takes only `body` and `stylesheet`, one of each; its body binds the files it names.",
      "type": "string",
      "enum": [
        "body",
        "staged",
        "staged_file",
        "prose",
        "teaser",
        "embed",
        "deliverable",
        "poster",
        "logo",
        "prompt",
        "stylesheet"
      ]
    },
    "delivery": {
      "type": "string",
      "enum": [
        "inline",
        "download",
        "stream"
      ]
    },
    "preview_only": {
      "type": "boolean"
    },
    "position": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "if_none": {
      "description": "Refused when the target already holds one in this role.",
      "type": "boolean"
    },
    "if_none_of": {
      "description": "Refused while the target holds a file of this kind in the role that its body didn't bind; the asset must be one, or it refuses `conflict` on `mime` with the reason.",
      "type": "string",
      "enum": [
        "video",
        "audio",
        "pdf"
      ]
    }
  },
  "required": [
    "target",
    "asset",
    "role"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
target object Yes
role string Yes
delivery string Yes
preview_only boolean Yes
from_body boolean Yes
release_file boolean Yes A file a software release ships, which its release edits and the product’s own list leaves out.
position number Yes
asset object Yes

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

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, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
  • client-fault: the server failed around the call. core_answer ok means the write landed, so don’t send it again. When reached_core is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
  • 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