Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview

Set Asset Tags

Replace one asset’s tags.

:path because the id is the storage key, which has slashes in it. Any writer may tag any author’s asset — the gallery is the team’s, and enforce_write_role is the whole gate.

PATCH/api/v1/assets/{key}/tags
Authorization
AuthorizationBearer token · headerrequired
or
AuthorizationOAuth2 access token · headerrequired
Path parameters
keystringrequired
Request body
requiredapplication/json
tagsstring[]required
max items 20
Responses
200Successful Response
successboolean
default: true
dataGeneratedAsset | any
Show properties
Any of:
GeneratedAsset
idstringrequired
urlstringrequired
sha256stringrequired
kindAssetKindrequired
What a generated file is. The values match the engine's media `PortType`s deliberately: the harvest that finds these files reads the kind off a node's declared output port, and hands the value over as a plain string so neither package has to import the other.
Allowed:imagevideoaudio
node_typestringrequired
node_idstringrequired
modelstring | any
Show properties
Any of:
string
string
any
any
promptstring | any
Show properties
Any of:
string
string
any
any
run_idstringrequired
run_generationinteger | any
Show properties
Any of:
integer
integer
any
any
graph_idstring | any
Show properties
Any of:
string
string
any
any
owner_idstringrequired
tagsstring[]
created_atstring<date-time>
any
any
messagestring | any
Show properties
Any of:
string
string
any
any
errorsstring[] | any
Show properties
Any of:
string[]
Array of string
string
any
any
422Validation Error
detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X PATCH "/api/v1/assets/string/tags" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": [
    "string"
  ]
}'
Response
{
  "success": true,
  "data": {
    "id": "string",
    "url": "string",
    "sha256": "string",
    "kind": "image",
    "node_type": "string",
    "node_id": "string",
    "model": "string",
    "prompt": "string",
    "run_id": "string",
    "run_generation": 0,
    "graph_id": "string",
    "owner_id": "string",
    "tags": [
      "string"
    ],
    "created_at": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}