Download a file
Request, parameters, response and errors of GET /v1/files/{id}/content.
Last updated:
Returns the bytes of the original file as a download (Content-Disposition: attachment), with the stored media type, or application/octet-stream if none is stored. The whole file comes in one response: there are no variants such as thumbnails, no Range requests and no HEAD. sizeBytes in the metadata of the file gives the length up front. Needs read access to files.
Requires the scope read and at least the level read on files.
Request
GET https://api.athaus.ai/v1/files/{id}/contentParameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | UUID of the file. |
Header
| Name | Type | Required | Description |
|---|---|---|---|
Athaus-Version | string | no | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
Example
curl "https://api.athaus.ai/v1/files/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17/content" \
-H "Authorization: Bearer ath_live_..." \
-o fileResponse
On success the status is 200 with the bytes of the file as application/octet-stream, not as JSON. An error still arrives as JSON in the envelope.
Response headers
| Header | Description |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Content-Disposition | attachment, with the file name of the file. |
Content-Length | The size of the file in bytes. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_id, api_version_unsupported | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.