Skip to content

Download a companion file

GET
/assets/{id}/companions/{companion_id}

Returns the stored bytes of one companion file, such as a texture or material library that an asset’s main file refers to. Get the companion’s id from GET /assets/{id}/companions.

The stored original is sent as is, with no conversion, always as application/octet-stream: the type recorded for the companion (content_type in the list) isn’t sent. Content-Length is set from the stored size when it isn’t zero. Range requests aren’t supported, and no caching or file-name headers are sent.

You need to be signed in, and any account can download any companion: the asset’s owner and access rules aren’t checked, and a companion of an asset in the trash can still be downloaded until the asset is permanently deleted. A 404 means no companion with that id belongs to that asset, or its stored file is missing. An id that isn’t a UUID gets a plain-text 400, and other server errors a plain-text 500, not the JSON shown. An error after the bytes have started can leave a cut-off 200 response.

id
required
string format: uuid

The id of the asset the companion belongs to.

companion_id
required
string format: uuid

The companion’s id, from GET /assets/{id}/companions.

The companion’s stored bytes, sent without conversion.

string format: binary

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed