Skip to content
Hayonix

API reference · Files

Download a file's content

GET/v1/files/{file_id}/content
API keyfile:readProject
TypeScript
client.files.getContent()
Python
client.files.get_content()
CLI
hayonix files download

Streams the stored bytes as an attachment under the original filename. Where a request cannot carry credentials, create a download link instead.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the file:read permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS "$API_BASE_URL/files/file_01jc5zq4m8k3v6x9t2w7r0b1e4/content" \
  -H "Authorization: Bearer $API_KEY" \
  -o output.bin

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • file_idstringrequired

    ID of the file

    ID with prefix file_

Response

200 the file content (application/octet-stream) — The bytes

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.