Skip to content
FlixMLFlixML Docs

Update Media

PATCH
/api/media/{path}/metadata
curl --request PATCH \
  --url https://example.com/api/media/example/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "The ridge at dusk, second pass", "tags": [ "keeper", "portrait" ], "character_ids": [ "example" ], "included_in_training_dataset": true }'

Edit an asset’s human-authored fields: caption, tags, subjects, training flag.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
path
required
Path
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MediaMetadataPatch

Everything about an asset a human edits after it exists.

Every field is optional and omitting one leaves it alone — a PATCH carrying only tags must not clear a caption.

object
description
Any of:
string
tags
Any of:
Array<string>
character_ids
Any of:
Array<string>
included_in_training_dataset
Any of:
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Update Media Api Media Path Metadata Patch
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}