PATCH
/
v1
/
assets
/
{asset_id}
curl --request PATCH \
  --url https://api.mixpeek.com/v1/assets/{asset_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "propagate_features": true,
  "metadata": {
    "description": "A new description",
    "title": "New Title"
  }
}'
{
  "asset_id": "ast_123",
  "collection_id": "col_123",
  "status": "processing",
  "file_data": {
    "file_size_bytes": 1000000,
    "file_type": "image/jpeg"
  },
  "metadata": {
    "description": "A new description",
    "title": "New Title"
  },
  "error": "<any>",
  "modality": "image",
  "task_id": "task123",
  "file_hash": "hash123",
  "updated_at": "2023-01-01T00:00:00.000Z",
  "created_at": "2023-01-01T00:00:00.000Z",
  "score": 0.5,
  "url": "<string>",
  "preview_url": "<string>",
  "duplicate_of": "<string>"
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

​
asset_id
string
required

Body

application/json
​
propagate_features
boolean | null
default:false

If True, the features will be propagated to all assets with the same asset_id

Example:

true

​
metadata
object

Updated metadata for the asset. This can include any key-value pairs that should be updated or added to the asset's metadata.

Example:
{
  "description": "A new description",
  "title": "New Title"
}

Response

200
application/json
Successful Response
​
asset_id
string | null

The unique identifier for the asset

Example:

"ast_123"

​
collection_id
string | null

The ID of the collection the asset belongs to

Example:

"col_123"

​
status
string | null

The current status of the asset processing

Example:

"processing"

​
file_data
object | null

File data associated with the asset

Example:
{
  "file_size_bytes": 1000000,
  "file_type": "image/jpeg"
}
​
metadata
object | null

Additional metadata associated with the asset

Example:
{
  "description": "A new description",
  "title": "New Title"
}
​
error
any | null

The error message if the asset processing failed

​
modality
string | null

The type of media

Example:

"image"

​
task_id
string | null

The task ID

Example:

"task123"

​
file_hash
string | null

The unique hash of the

Example:

"hash123"

​
updated_at
string | null

The timestamp when the asset was last updated

Example:

"2023-01-01T00:00:00.000Z"

​
created_at
string | null

The timestamp when the asset was created

Example:

"2023-01-01T00:00:00.000Z"

​
score
number | null

The relevance score of the asset

Example:

0.5

​
url
string | null

The presigned URL for accessing the asset

​
preview_url
string | null

The presigned URL for accessing the asset preview

​
duplicate_of
string | null

The asset_id of the asset that this asset is a duplicate of

Was this page helpful?

Suggest editsRaise issue