Skip to main content
POST
/
v1
/
assets
/
{id}
Error
A valid request URL is required to generate request examples
{
  "asset_id": "asset_d8aad64dib2c7m3ae7j1",
  "status": "ready",
  "filename": "q2-launch-deck.pdf",
  "mime_type": "application/pdf",
  "size_in_bytes": 1048576,
  "created_at": "2026-05-23T10:15:30Z"
}

Authorizations

​
X-API-Key
string
header
required

Personal Access Token, sent verbatim as pat_<32 chars>. PATs are minted from the Chief settings UI.

Headers

​
X-Project-Id
string
required

Project identifier scoping the request. Required on every project-scoped public endpoint. Missing or malformed values respond with HTTP 400 and code publicapi.tenancy.project.missing.

Pattern: ^project_[a-z0-9]{20}$

Path Parameters

​
id
string
required

Asset identifier returned by POST /v1/assets.

Pattern: ^asset_[a-z0-9]{20}$

Body

application/json

Patch an asset's mutable metadata. Both fields are optional; omitting one leaves it unchanged. Only allowed once the asset is ready.

​
name
string
​
description
string

Response

Asset updated.

​
asset_id
string
required
Pattern: ^asset_[a-z0-9]{20}$
​
status
enum<string>
required

Asset lifecycle. Progresses uploaded -> ingesting -> ready, or terminates at failed on any extraction error.

Available options:
uploaded,
ingesting,
ready,
failed
​
filename
string
required
​
mime_type
string
required
​
size_in_bytes
integer<int64>
required
​
created_at
string<date-time>
required